Develop documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Jupyter Notebook
- Stars
- 14
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
Following #22, a simple documentation site should be initiated. Preference is Zensical.
Components to add on first pass include:
- Quick reference: Worked example starting from existing masks
- A sub-page illustrating how to generate the first mask using a few tools (napari, X-AnyLabeling, Label Studio, Fiji). At least one should go into the first docs produced. Additional examples can be added in subsequent issues.
- Installation
- IO: format specifications for what comes into SST and what is produced
- Acknowledgements
Contributor guide
No contributing guide indexed for this repository
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
Start with issue #22 and the Zensical getting-started documentation to determine how the documentation site should be initiated. Build the first pass around Quick reference, Installation, IO, and Acknowledgements, including at least one worked mask-generation example using one of napari, X-AnyLabeling, Label Studio, or Fiji. Done means the site exists with these initial sections and the example is usable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100