Skip to content
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

Reorganize the project concept documentation #9121

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

zanieb
Copy link
Member

@zanieb zanieb commented Nov 14, 2024

  • Adds a collapsible section for the project concept
  • Splits the project concept document into several child documents.
  • Moves the workspace and dependencies documents to under the project section
  • Adds a mkdocs plugin for redirects, so links to the moved documents still work

I attempted to make the minimum required changes to the contents of the documents here. There is a lot of room for improvement on the content of each new child document. For review purposes, I want to do that work separately. I'd prefer if the review focused on this structure and idea rather than the content of the files.

I expect to do this to other documentation pages that would otherwise be very nested.

The project concept landing page and nav (collapsed by default) looks like this now:

Screenshot 2024-11-14 at 11 28 45 AM

@zanieb zanieb added the documentation Improvements or additions to documentation label Nov 14, 2024
@zanieb zanieb force-pushed the zb/docs-collapsible-project branch 5 times, most recently from e89217d to 134e999 Compare November 14, 2024 17:28
@zanieb zanieb marked this pull request as ready for review November 14, 2024 17:30
@AlexWaygood AlexWaygood self-requested a review November 14, 2024 19:18
mkdocs.template.yml Outdated Show resolved Hide resolved
@dhruvmanila
Copy link
Member

dhruvmanila commented Nov 15, 2024

I think splitting larger pages into does make sense. We should enable navigation.path (navigation path breadcrumbs) so that it's easy to understand where the user is currently at. It might be problematic because of the "Introduction" page that exists currently but that can possibly be solved.

I'm still a big fan of having a third dimension to navigation aka tabs where the top level sections go but that's an unrelated discussion.

@dhruvmanila
Copy link
Member

dhruvmanila commented Nov 15, 2024

One thing I noticed is that the footer seems to be a bit annoying when clicking on the "Projects" section because it occupies the entire screen width. I don't know if it's possible but limiting that only to the content region (and not the navigation and table of content) would be a good UX improvement IMO.

@zanieb
Copy link
Member Author

zanieb commented Nov 15, 2024

I'm still a big fan of having a third dimension to navigation aka tabs where the top level sections go but that's an unrelated discussion.

Agree, it just makes it a lot harder to incrementally add more sections because it's a weird experience to switch to tabs without creating and populating a lot of child pages.

One thing I noticed is that the footer seems to be a bit annoying when clicking on the "Projects" section because it occupies the entire screen width. I don't know if it's possible but limiting that only to the content region (and not the navigation and table of content) would be a good UX improvement IMO.

I feel the same. In my larger reorg, I actually implemented this in an attempt to show more of the nav

Screenshot 2024-11-15 at 9 48 19 AM

However, this requires JS to dynamically move the element by editing the DOM (you can't style it up into the content).

I think we either need to fork our own theme and change it there, or... idk.

Edit: I had another idea that should solve this in the meantime — #9153

@zanieb
Copy link
Member Author

zanieb commented Nov 15, 2024

We should enable navigation.path (navigation path breadcrumbs) so that it's easy to understand where the user is currently at. It might be problematic because of the "Introduction" page that exists currently but that can possibly be solved.

This seems to have no effect locally for me, which is surprising. I agree it'd be nice to have — I think I tried turning it on previously but was annoyed by the "Introduction" page as you mentioned.

Base automatically changed from zb/docs-collapsible to main November 15, 2024 23:00
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.

2 participants