Skip to content

docs: set sidebar order for introductory pages#6118

Closed
chiawendt wants to merge 1 commit into
fastify:mainfrom
chiawendt:docs-sidebar-ordering
Closed

docs: set sidebar order for introductory pages#6118
chiawendt wants to merge 1 commit into
fastify:mainfrom
chiawendt:docs-sidebar-ordering

Conversation

@chiawendt

Copy link
Copy Markdown
Contributor

Fixes fastify/website#308

This PR set sidebar position for introductory pages, making them listed before more advanced topics, in the order of:

  • Getting-Started.md
  • Database.md
  • Recommendations.md
  • Testing.md

Docusaurus sidebar docs:
https://docusaurus.io/docs/sidebar/autogenerated#doc-item-metadata

Checklist

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 9, 2025
@chiawendt chiawendt force-pushed the docs-sidebar-ordering branch from 307b6ef to 106c904 Compare May 9, 2025 12:25

@Fdawgs Fdawgs left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes on getting-started but tentative on the order of the rest. Needs a think.

@Eomm Eomm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We have these Project Boundaries
fastify/website#32

We don't want site related stuff here.

We have a many scripts to manipulate the documentation payload:
https://github.com/fastify/website/blob/main/scripts/build-website.sh#L29-L31
So we must implement something there

@jsumners

jsumners commented May 9, 2025

Copy link
Copy Markdown
Member

We have these Project Boundaries fastify/website#32

We don't want site related stuff here.

We have a many scripts to manipulate the documentation payload: fastify/website@main/scripts/build-website.sh#L29-L31 So we must implement something there

I wanted to ask: is there not a better way to do this that doesn't break our Markdown? Thank you.

@chiawendt

Copy link
Copy Markdown
Contributor Author

We have these Project Boundaries fastify/website#32

We don't want site related stuff here.

I moved the position metadata to the website build script.

This PR is moved to fastify/website#309 .

@github-actions

Copy link
Copy Markdown

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Mar 24, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Proper ordering of pages in sidebar

4 participants