How/where/what to document
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- documentation
Research direction
No specific files, tests, or entry points are identified. Review the existing README and documentation structure first, then define a contribution guide covering where permissions, routes, user flows, and getting-started information should live.
Written by the indexing model from the issue text.
Description
I have always felt that there should be more of a process/guidelines when it comes to documenting stuff. I imagine there is a lot overlap with what you want to be documented across projects (permissions/routes/user-flows/getting-started/...).
It would help to have a specific guide to follow so that I know where to add this piece of information rather than just stick it on the end of a potentially long readme.
- Dominant language
- No language data
- Stars
- 92
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
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 dwyl/contributing
-
bug chore starter
Difficulty 1/5 Under an hour Newbie friendliness 38/100
dwyl/contributing#119 · 1 reaction ·
-
enhancement starter
Difficulty 1/5 1-3 hours Newbie friendliness 35/100
dwyl/contributing#118 · 1 reaction ·
-
discuss enhancement
Difficulty 4/5 3-5 days Newbie friendliness 25/100
dwyl/contributing#113 · 2 reactions ·
-
discuss enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
dwyl/contributing#112 · 1 reaction ·
-
Draft Pull Requests!Opendiscuss enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
dwyl/contributing#111 · 2 comments · 3 reactions ·
All issues in dwyl/contributing
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
supadata-ai/mcp#27 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Albert-Weasker/niubigeo#194 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Esri/calcite-dotnet-toolkit#30 · 1 reaction ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 62/100
supabase/agent-skills#623 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100