Develop documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
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.
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
- Dominant language
- Jupyter Notebook
- Stars
- 16
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 Imageomics/SST
-
napari-sst plugin: integrate reference mask annotation into napariMay be free again @sahasra-yikuntam claimed this 59 days ago, and no pull request is open. Open
Imageomics/SST#30 · 1 assignee ·
-
Create initial documentation site contentsMay be free again @sahasra-yikuntam claimed this 75 days ago, and no pull request is open. Opendocumentation
Imageomics/SST#29 · 1 assignee ·
-
Set PR preview builds (and site hosting) to go through Cloudflare to prevent gh-pages branch bloat.May be free again @thompsonmj claimed this 75 days ago, and no pull request is open. Open
Imageomics/SST#28 · 1 assignee ·
-
Package for PyPI publicationPossibly taken @thompsonmj claimed this 173 days ago. Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
Imageomics/SST#22 · 1 reaction ·
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
raspberrypi/pico-feedback#508 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
level/subtask type/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
wazuh/wazuh-virtual-machines#1091 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day