You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As an active project, we need to keep the onboarding documentation updated so that newcomers have an easier time getting through the initial tasks. For this issue, we need to update the CONTRIBUTING.md table of contents, or remove it and tell people to use the GitHub auto-generated outline instead.
Action Items
[Option 1] Remove the ToC and use the auto-outline
Remove the ToC
Add instruction on how to toggle the outline
[Option 2] Update the ToC
Fix indents
Fix the order of items
Add missing item
Fix bad link and verify other links
Resources/Instructions
The image shows several things:
There's a button in the upper-right to toggle the auto-outline, which is the column to the right.
The manually-maintained ToC in the document now contains some errors:
Some items should have reduced indentation (see short arrowed lines on the left)
A couple items have swapped positions (see dotted line)
One link is bad (see double arrow dashed line)
One item is missing (see dotted single arrow line)
The text was updated successfully, but these errors were encountered:
Overview
As an active project, we need to keep the onboarding documentation updated so that newcomers have an easier time getting through the initial tasks. For this issue, we need to update the CONTRIBUTING.md table of contents, or remove it and tell people to use the GitHub auto-generated outline instead.
Action Items
Resources/Instructions
The image shows several things:
The text was updated successfully, but these errors were encountered: