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

Restructure docs user-guide for toc-depth #140

Merged
merged 8 commits into from
Jul 26, 2022
Merged

Conversation

danielhuppmann
Copy link
Member

This PR restructures the user guide such that the TOC in the left-hand navigation bar of the docs shows sub-headers of a page - and it separates the user-guide for specific dimensions and removes some duplicate sections.

The updated pages are rendered here

closes #138

@danielhuppmann danielhuppmann added the documentation Improvements or additions to documentation label Jul 26, 2022
@danielhuppmann danielhuppmann self-assigned this Jul 26, 2022
Copy link
Contributor

@phackstock phackstock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great to me. It's a lot better with the dedicated pages on the region and variable codelists. That's gonna make it a lot easier to quickly find things.

@phackstock
Copy link
Contributor

Next in line would probably be the refactor of the generic codelist class into dedicated region and variable sub-classes in analogy to the restructured docs.

@danielhuppmann danielhuppmann merged commit f96d0ec into main Jul 26, 2022
@danielhuppmann danielhuppmann deleted the docs/navbar-toc-depth branch July 26, 2022 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Navbar in docs does not expand enough
2 participants