Skip to content

docs: set sidebar order for introductory pages #6118

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

Closed
wants to merge 1 commit into from

Conversation

golopot
Copy link
Contributor

@golopot golopot commented May 9, 2025

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
@golopot golopot force-pushed the docs-sidebar-ordering branch from 307b6ef to 106c904 Compare May 9, 2025 12:25
Copy link
Member

@Fdawgs Fdawgs left a comment

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.

Copy link
Member

@Eomm Eomm left a comment

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
Copy link
Member

jsumners commented May 9, 2025

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.

@golopot
Copy link
Contributor Author

golopot commented May 10, 2025

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 .

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.

Proper ordering of pages in sidebar
4 participants