JuliaDynamics / JuliaDynamics/ConcurrentSim.jl
documentation reorganizing
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 198
- Forks
- 40
- Avg merge
- 21h 40m
- Merged PRs (30d)
- 2
Description
Currently we have two parallel sections in the documentation which have pretty bad overlap: "Tutorial" and "Topical Guides". For instance, both have a "basics" sections. We should clean this up so that the flow of the documentation is clearer.
Following the Divio system is not a bad idea either https://documentation.divio.com/ (I think that was a goal, but the current execution of it is pretty confusing with no clear distinction between "tutorial" and "guide").
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
Review the existing “Tutorial” and “Topical Guides” sections and compare their structure with the Divio documentation system linked in the issue. Define a non-overlapping information architecture and clearer flow, then consider the reorganization complete when the duplicated basics material has a clear, single home.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100