Conversation
|
🌿 Preview your docs: https://nvidia-preview-pr-797.docs.buildwithfern.com/openshell |
This comment was marked as resolved.
This comment was marked as resolved.
|
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
|
@pimlock Thank you for catching! Removed "Documentation" |
Now the "Home" is indented a bit too much. It may need a custom CSS?
|
|
@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. |
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 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. |
|
@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.
I honestly recommend removing Home, as the top bar has the functionality, and that's I believe the common pattern for any websites. |

Summary
Bring Get Started section back.
Related Issue
Changes
Testing
mise run pre-commitpassesChecklist