Develop documentation

Open
#24 0 comments 2 reactions 0 assignees View on GitHub

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

documentation

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Imageomics/SST

All issues in Imageomics/SST

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.