shared docs files unclear
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 38/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Compare anatomy/tracks/shared-files.md with the Track Anatomy Example linked from the anatomy/tracks page, focusing on the listed exercises/shared/.docs files. Determine which file list is authoritative, then update the inconsistent documentation so both references agree and verify the links and examples remain correct.
Written by the indexing model from the issue text.
Description
There is a difference in file list of exercises/shared/.docs files between Shared Files (debug.md, help.md, tests.md) and Track Anatomy Example (debug.md, cli.md).
- Dominant language
- No language data
- Stars
- 52
- Forks
- 98
- Avg merge
- 9m
- Merged PRs (30d)
- 4
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 exercism/docs
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
Similar issues
-
Link Checker ReportOpenautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
PedestrianDynamics/pyFDS-Evac#475 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ethereum/execution-apis#915 ·
Maintainers usually reply within 1 day
-
area:ansible source:reader type:content-error
Difficulty 1/5 Under an hour Newbie friendliness 86/100
stephrobert/blog-roadmap#42 ·