-
Notifications
You must be signed in to change notification settings - Fork 45
Initial sidebar links, further setup tweaks #2
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
Conversation
|
Before I put this up, @clouserw suggested that it might be nice to model the sidebar links using this guidance. I like the idea of having tutorials, guides, and references, and this kind of setup could help keep things organized. Since this is a hub and there will be sections that only apply to certain groups of people (i.e. data science might not care about desktop engineer stuff), maybe these organizing categories could live underneath the links of each topic. cc @LZoog @k88hudson thoughts? |
I like the way this looks as well, though is it a little premature to make it this layered with the amount of docs that we have planned right now? Maybe we could create a follow up ticket for this? It looks great how you have it in this PR IMO with the collapsible sections. :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This LGTM! I double checked all the links were there, and I think this setup/organization is great👌
|
|
||
| :::important | ||
|
|
||
| One caveat to adding new pages is that if you want them to show up in the sidebar they must be added to the [sidebars.js](https://github.com/mozilla/experimenter-docs/blob/main/sidebars.js) file. If you are adding a new file using the GitHub UI you must first make sure you have changed to the branch you just created with your new page commit. Then you can use the UI to add your new page to the sidebar and add that commit to the Pull Request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wellllll... I could have sworn Docusaurus did this automagically.
9512300 to
c000056
Compare
Thanks for your input here! I do like the suggested way of organizing into references, guides, tutorials, etc. but you might be right that it's early for this. I've created https://jira.mozilla.com/browse/EXP-1048 so we can follow up and maybe try a re-organization once we have more content. cc @clouserw |
Gist: this PR adds a bunch of empty doc pages and external links for new sections in the sidebar, a basic Welcome doc, a handful of configuration changes, search capability, and some cosmetic tweaks.
Specifically: