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

[2.x] Move the sidebar documentation to the documentation pages page #1841

Merged

Conversation

caendesilva
Copy link
Member

Targets #1818

This PR reorganizes and improves the documentation for navigation menus and documentation pages in Hyde. The main changes are:

  1. Move sidebar-specific content from navigation.md to documentation-pages.md
  2. Update customization.md to reflect the new organization
  3. Add missing information about numerical prefix ordering to documentation-pages.md

Motivation:

  • Reduce duplication and potential inconsistencies in the documentation
  • Improve the overall organization of the docs, making it easier for users to find relevant information
  • Ensure all features, including numerical prefix ordering, are properly documented

Benefits:

  • Clearer separation of concerns between main navigation and documentation sidebar
  • More comprehensive and accurate documentation for Hyde users
  • Easier maintenance of documentation in the future

These changes will help Hyde users better understand and utilize the navigation and documentation features, leading to improved developer experience and more efficient use of the framework. Generally readers will be looking on how to use a specific feature such as main menus or sidebars, so it's distracting to have two areas in one file.

@caendesilva caendesilva changed the base branch from master to unify-the-navigation-api July 12, 2024 15:36
@caendesilva caendesilva mentioned this pull request Jul 12, 2024
4 tasks
Copy link

codecov bot commented Jul 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (89fe3e0) to head (8427e55).
Report is 1 commits behind head on unify-the-navigation-api.

Additional details and impacted files
@@                     Coverage Diff                      @@
##             unify-the-navigation-api     #1841   +/-   ##
============================================================
  Coverage                      100.00%   100.00%           
  Complexity                       1855      1855           
============================================================
  Files                             190       190           
  Lines                            4909      4909           
============================================================
  Hits                             4909      4909           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@caendesilva caendesilva marked this pull request as ready for review July 12, 2024 16:01
@caendesilva caendesilva merged commit f7870ad into unify-the-navigation-api Jul 12, 2024
7 checks passed
@caendesilva caendesilva deleted the clean-up-the-navigation-documentation branch July 12, 2024 16:01
@caendesilva caendesilva changed the title Move the sidebar documentation to the documentation pages page [2.x] Move the sidebar documentation to the documentation pages page Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant