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

Generate docs sidebar sections automatically #480

Merged
merged 1 commit into from
Jul 2, 2024

Commits on Jul 1, 2024

  1. Generate docs sidebar sections automatically

    Add a `config.json` field within each `navigation` entry called
    `generateFrom`. This designates a relative path from `docs/pages` from
    which to generate entries within the sidebar.
    
    When generating pages, a function called `generateNavPaths` looks for
    pages to use as second-level section introductions. As with the
    Docusaurus convention, second-level section introductions have the same
    name as their parent directory.
    
    Adding a `generateFrom` field is consistent with the Docusaurus
    approach to sidebar generation, in which a configuration field indicates
    which directory to generate a section from. This gives us control over
    the title and icons we use for navigation sections, which aren't
    available to fetch from a directory tree alone. It also lets us use the
    current, hardcoded `entries` approach for some sections if we need to.
    
    Also un-skips some accidentally skipped tests.
    ptgott committed Jul 1, 2024
    Configuration menu
    Copy the full SHA
    c6d9cdd View commit details
    Browse the repository at this point in the history