Add a Table of Contents to README
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 92/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- markdown
- Domain
- documentation
Research direction
Open the README and review its main section headings, especially the banner and the “Why Metcode” section. Add a table of contents between the banner and “Why Metcode,” with clickable links to each main section. Done when the README is the only changed file and every main section is represented by a working link.
Written by the indexing model from the issue text.
Description
What
Add a table of contents to the top of the README right above the Why Metcode section, so underneath the banner.
Proposed Change
There is no table of contents for someone coming to the README to see what the readme has on it. There should be a small table of contents with all the major headings on the README so that someone can click on them and it will take them to the proper section of the README
Acceptance Criteria
Should only change the readme file. Should have a new table of contents section under the header and above why metcode. And should have all the main sections with clickable hyper references that take the user down to that section of the readme.
- Dominant language
- Go
- Stars
- 1
- Forks
- 2
- Avg merge
- 18h 26m
- Merged PRs (30d)
- 11
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Edwin-metcalf/MetCode
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Edwin-metcalf/MetCode#24 ·
Maintainers usually reply within 1 day
-
documentation enhancement help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Edwin-metcalf/MetCode#19 ·
Maintainers usually reply within 1 day
-
testing
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Edwin-metcalf/MetCode#9 ·
Maintainers usually reply within 1 day
-
Add a MakefileOpenenhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Edwin-metcalf/MetCode#8 ·
Maintainers usually reply within 1 day
-
Add a --host flagOpenenhancement
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Edwin-metcalf/MetCode#7 ·
Maintainers usually reply within 1 day
All issues in Edwin-metcalf/MetCode
Similar issues
-
bug triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
mvanhorn/cli-printing-press#5146 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AvengeMedia/DankMaterialShell#3853 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 60/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day