Closed ACharbonneau closed 3 years ago
Hi!
I noticed the left-side TOC on the cookbook page still has a few duplicate labels and pages to reorder (e.g., "Overview" should be the first header under "Recipes" and "Intro" the first under "Governance"):
I've made some of the edits in this PR: https://github.com/nih-cfde/the-fair-cookbook/pull/53
.pages
to make Introduction landing page (this should get rid of the duplicate "Introduction" header).pages
to "Governance" directory.pages
to add "Overview" for recipes directory
.html
instead of .md
file extensions.pages
file I made. Add it back if you'd like it rendered on the website!I didn't add .pages
to the other directories under "Recipes" in my PR, but if you'd like to order those pages, the format will be the same as the ones I've added. Let me know if you need help!
I've fixed the render issues for the cookbook on the docs website - https://docs.nih-cfde.org/en/latest/the-fair-cookbook/intro/
There are lots of places where content probably needs to be updated, but the TOC structure is now in place!
There are a couple places where the render is slightly weird, and it's due to the little index pages:
see https://cfde-published-documentation.readthedocs-hosted.com/en/latest/the-fair-cookbook/
Basically, it's adding them as aTOC listing additional to the auto-generated one, so there's two of each, and the links within both those files are broken.
If you need these pages for the cookbook, it's fine to leave them, you just need to add a
.pages
file in the directory each one is in that specifies the folders it should render and leaves out that file. AwesomePages will ignore any files not listed in a.pages
file if the.pages
file exists. If you don't need them for the cookbook, just deleting those two pages fixes the render issue.The other thing I noticed is that in Governance, the ordering of the contents seems weird: "Intro" is second to last instead of first. This can also be fixed by specifying the order for files/folders in Governance with a
.pages
file.I've written some more detailed instructions about how the system works at https://github.com/nih-cfde/published-documentation/blob/dev/README.md