Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Arrange Chapters in Pathway ToC as Ordered by the Author #16

Open
Preshh0 opened this issue Nov 18, 2024 · 4 comments
Open

Arrange Chapters in Pathway ToC as Ordered by the Author #16

Preshh0 opened this issue Nov 18, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@Preshh0
Copy link

Preshh0 commented Nov 18, 2024

Right now, the chapters in a pathway created revert back to the order they are in the main guide. In a case where a pathway requires a different order for its specific use case, the author would be unable to do that because of the way it is currently setup.

It would be great if authors of pathways could alter the order of the chapters when collating resources for a specific pathway.

This issue arose as a result of this: the-turing-way/the-turing-way#3949 (comment).

@JimMadge JimMadge added the enhancement New feature or request label Nov 18, 2024
@JimMadge
Copy link
Member

I would guess this is intentional, the pathways pages have their own ToC nested in the same way as the book. I can see how that achieve the idea of curating the book for particular roles.

@malvikasharan do you recall if there was any discussion about this before?

If we wanted to add a feature for ordering pages differently, we should make it optional so that the existing pathways remain as they are.

@Preshh0
Copy link
Author

Preshh0 commented Nov 18, 2024

Yes, I think making optional would be a helpful feature.

@malvikasharan
Copy link
Contributor

Hey @Preshh0, as @JimMadge says, the ordering as the book's guide is intentional. We provide a curated set of chapters but the side navigation of chapters in the book doesn't change, helping orient users as much as possible in the larger set of files.

Any changes would require altering the source code - although this issue doesn't seem too critical, I agree with Jim to keep this feature optional. Meaning, it would be likely more than a couple of lines of code that need to be added. Our current maintainers @arya1302 and @likeajumprope might not be available to respond promptly but I have tagged them here in case they can.

However, as an issue requesting for this feature is worth keeping open in case anyone else might want to test and develop this. Does this feature cause any blocker to the curation you are doing?

@Preshh0
Copy link
Author

Preshh0 commented Nov 18, 2024

Thank you for more context @malvikasharan, it does make sense. Thank you too @JimMadge.

It doesn't affect it too badly, it just alters the order which I arranged the chapters in the curation. I was hoping readers would build knowledge on the order the pathway is presented in.

However, I do understand these concerns and it is not a very critical need right now. It can be kept open for the future, but I can merge my PR in the meantime.

Thank you both for your help @JimMadge and @malvikasharan.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants