Skip to content

docs: fix TOC structure - #797

Merged
miyoungc merged 6 commits into
mainfrom
docs/structure-cleanup
Apr 17, 2026
Merged

docs: fix TOC structure#797
miyoungc merged 6 commits into
mainfrom
docs/structure-cleanup

Conversation

@miyoungc

@miyoungcmiyoungc commented Apr 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

Bring Get Started section back.

Related Issue

Changes

Testing

  • mise run pre-commit passes
  • Unit tests added/updated
  • E2E tests added/updated (if applicable)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (if applicable)

@miyoungc
miyoungc requested a review from a team as a code ownerApril 9, 2026 21:13
@miyoungc
miyoungc requested a review from pimlockApril 9, 2026 21:13
@github-actions

Copy link
Copy Markdown

@pimlock

This comment was marked as resolved.

@pimlock

Copy link
Copy Markdown
Collaborator

I moved documentation files in a recent PR, so you'll need to update your branch. I recommend asking your agent to do it (and you can point it to the PR description for context).

Merge origin/main into docs/structure-cleanup. Resolve rename/rename
conflicts for tutorial files by placing them at docs/get-started/tutorials/,
combining main's fern-to-docs migration with the get-started restructuring.
Made-with: Cursor
@miyoungc

Copy link
Copy Markdown
CollaboratorAuthor

@pimlock Thank you for catching! Removed "Documentation"

@pimlock

Copy link
Copy Markdown
Collaborator

@pimlock Thank you for catching! Removed "Documentation"

Now the "Home" is indented a bit too much. It may need a custom CSS?

CleanShot 2026-04-09 at 16 50 02@2x

@miyoungc

Copy link
Copy Markdown
CollaboratorAuthor

@pimlock We can remove it if you think this is unnecessary. We added it before per Kirit's ask cause it was not obvious how to go back to the landing page. We had Table of Content at the top of the TOC before, like you can still see it in the NemoClaw doc: https://docs.nvidia.com/nemoclaw/latest/index.html

But that "Home" is completely optional thing and we can remove. I personally think it is intuitive enough that if you click the product name at the top you'd know you can go back to the landing page.

Comment threadfern/docs.yml
@pimlock

Copy link
Copy Markdown
Collaborator

But that "Home" is completely optional thing and we can remove. I personally think it is intuitive enough that if you click the product name at the top you'd know you can go back to the landing page.

I see, that's definitely an option - remove the "Home" from the navigation and have it a landing page and accessible by clicking the "OpenShell" in the top-bar. That may be enough if we assume that page is not as useful outside of the first landing, as not having it in the navigation makes it less discoverable.
That's how current NeMo docs operate: https://docs.nvidia.com/nemo/microservices/latest/index.html

That kind of handling however is an outlier, all other docs I can see (dynamo, heavyai, brev) have a link to home in the navigation.

I'd love for basic things like this to be consistent, rather than trying to reinvent this for each page. Is there a reason why most pages don't follow the structure describe here? https://nvidia.atlassian.net/wiki/spaces/SWDOCS/pages/2639397140/Peer+Review+Checklist

Another option is to somehow include that Home in the "About ..." section (this is what some docs do). The pro here is that we are not introducing extra section just for home, but then Overview and Home are somehow redundant.


TL;DR I think for now I'd be most inclined to have a single "Home" link, but not indented, I feel like this is the cleanest for now and most consistent with all other docs.

@miyoungc

miyoungc commented Apr 10, 2026

Copy link
Copy Markdown
CollaboratorAuthor

@pimlock The template in the confluence page is recently finalized this year led by the docs leadership for achieving exactly that, "standardize the doc structure across the entire company's docs". All other docs are still in process of adopting the template. Home is not part of it, so I'd recommend removing it.
The following are the docs that adopted the finalized, standardized structure early.

I honestly recommend removing Home, as the top bar has the functionality, and that's I believe the common pattern for any websites.

@pimlock

Copy link
Copy Markdown
Collaborator

@miyoungc Sounds good with the home being accessible from the top navigation, if this is a consistent pattern.

@miyoungc

Copy link
Copy Markdown
CollaboratorAuthor

@pimlock removed Home

@pimlock

Copy link
Copy Markdown
Collaborator

@miyoungc Looking at the preview: https://nvidia-preview-pr-797.docs.buildwithfern.com/openshell the top navigation leads to the overview page and there is no way to get to home.

I think you may need to add it back to the index and mark it as hidden? There may be another way to do that as well.

@miyoungc

Copy link
Copy Markdown
CollaboratorAuthor

@pimlock yes, I'm noticing that too. Working on it

@miyoungcmiyoungc added the area:docs Documentation and examples label Apr 16, 2026
@miyoungc

Copy link
Copy Markdown
CollaboratorAuthor

@pimlock -- fixed the top bar logo to properly link to the landing page.

@miyoungc
miyoungc merged commit 2c9c146 into mainApr 17, 2026
17 checks passed
@miyoungc
miyoungc deleted the docs/structure-cleanup branch April 17, 2026 20:15
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docsDocumentation and examples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@miyoungc@pimlock