l3montree-dev / l3montree-dev/devguard
Reduce/compress explanations section
Open
Nobody has claimed this yet.
component/devguard-documentation
priority:low
- Dominant language
- Go
- Stars
- 161
- Forks
- 43
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 37
Description
Currently especially the explanations sections has a lot of different sub sections and entries. It is very difficult to get a quick overview. Maybe we can only focus on the most important concepts and strip off the rest.
Contributor 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.
Research direction
No file, test, or entry point is identified in the issue, so first locate the explanations section shown in the attached image and review its current structure. Clarify which concepts are essential and define completion as a shorter section with a quick, understandable overview.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100