Skip to content

Remove unused sidebar_position / position in docs with hardcoded sidebars #1385

Description

@m4sterbunny

Description

As a result of site overhaul, sidebars for Protocol, Network, Stack, and API are now defined in sidebars.js (explicit list of doc IDs). For those sections, Docusaurus does not use sidebar_position in front matter or position in category.json; order comes only from the order of items in sidebars.js.

This means that there may be category.json files and/or sidebar_position metadata that are now unused and can mislead contributors into thinking it controls sidebar order.

Proposed cleanup:

  • Strip sidebar_position from front matter of all docs under docs/protocol, docs/network, docs/api, and docs/stack (and remove or simplify position in category.json under those paths where it’s redundant).

In scope: docs/protocol, docs/network, docs/api, docs/stack (and their category.json where they use position).
Out of scope: docs/changelog (and any other autogenerated sidebar), where sidebar_position / position is still used and should remain. ALT is to align changelog with the rest of the site and put this in scope.

Labels (suggested)
documentation, cleanup, good first issue

Where should this content be added?

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions