Update dev docs for monorepo
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 1
- Forks
- 3
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 17
Description
The sphinx dev docs need to be updated to reflect the monorepo.
- They should probably move to the top-level ess docs instead of being replicated across packages.
- See #62 for a couple of points that should be explained on top of what's in the readme.
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 Sphinx development docs and the top-level ESS documentation, then compare them with the README and the points referenced in issue #62. Consolidate the development guidance at the top level rather than replicating it across packages, and ensure the requested monorepo details are explained.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100