Skip to content

Comments

docs: update top level navigation#7062

Closed
mdong1909 wants to merge 8 commits intorolldown:mainfrom
mdong1909:docs-structure
Closed

docs: update top level navigation#7062
mdong1909 wants to merge 8 commits intorolldown:mainfrom
mdong1909:docs-structure

Conversation

@mdong1909
Copy link
Collaborator

Reorganizes the navigation bar and includes activeMatch for readers to more easily see where they are.

  • Separated In-depth as standalone submenu and renamed to Concepts
  • Removed inconsistent active status
  • Turned Docs into a nested menu with Guide, Glossary, and Concepts
  • Moved Contribute under Resources
  • Removed social links from Resources
  • Renamed Config to References

This does NOT make any changes to References. This will be done in another PR that auto-generates documentation based typing

@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 16, 2025

How to use the Graphite Merge Queue

Add the label graphite: merge to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

@hyf0
Copy link
Member

hyf0 commented Nov 16, 2025

Renamed Config to References

I previewed the doc locally. I felt this's a negative change. References doesn't give people a clear intention for those want to inspect documentation about options, which should be the most frequent intention.

@hyf0
Copy link
Member

hyf0 commented Nov 16, 2025

Renamed Config to References

I previewed the doc locally. I felt this's a negative change. References doesn't give people a clear intention for those want to inspect documentation about options, which should be the most frequent intention.

IMO, we should keep calling it Config or Options in the navbar area.

@hyf0
Copy link
Member

hyf0 commented Nov 16, 2025

Think again, I feel References or API are more proper to be used to carry auto-gen docs made in #6838. It means something deeper and is for those want to get techenical.

@TheAlexLichter
Copy link
Collaborator

Think again, I feel References or API are more proper to be used to carry auto-gen docs made in #6838. It means something deeper and is for those want to get techenical.

API is tricky as it could be ambiguous for Rolldown.

From @sapphi-red:

API feels strange here because I think normally people won’t understand “options” as part of the API (even though technically it is). If it were called “API”, I would expect a reference for the programmable interface (the way to use Rolldown from scripts).

@mdong1909
Copy link
Collaborator Author

Closing as moved over to: #7092

@mdong1909 mdong1909 closed this Nov 17, 2025
@mdong1909 mdong1909 deleted the docs-structure branch November 19, 2025 08:00
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.

3 participants