Update contributing without references to bold headers #186
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sjspielman
changed the title
dvenprasad
reviewed
Mar 14, 2024
docs/contributing.md
Outdated
| - Markdown files within each nested directory will fall under this additional bold header. | ||
| - Nested directories within each `navbar` section should be used to add an sections along the left sidebar. | ||
| - We can have multiple levels of nested directories. | ||
| - Each nested directory should have an `index.md` file with an L1 header and an overall description of what that section contains. |
There was a problem hiding this comment.
I feel like this contrary to some of the directories, cause sometimes we directly display a doc within in the directory.
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Stacked on #171
Here, I'm just updating the contributing file to reflect our updated navbar look - no bold!
Also I do want to point out - with this approach, the left-side menu will be collapsed by default. This means only directory-level headers will be shown until you hit the dropdown arrow, which does make it harder to get a full sense of what all the docs are. I'm actually a little worried about this - I feel like we want it to be a little more transparent what the different levels of docs are? But maybe it's ok and the top-level
index.mdfile can provide the overview?