Make a docs site

Open
#37 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Quiet
Domain
documentation

Research direction

Start with the linked Zensical getting-started documentation and inspect sum-buddy's examples and downstream applications to determine the site's required guidance. Done means a Zensical site is set up for sum-buddy and provides user-friendly documentation for its multiple moving parts.

Written by the indexing model from the issue text.

Description

documentation enhancement

As @thompsonmj and I have discussed, sum-buddy is a larger package, in the sense of multiple moving parts, examples, and downstream applications that would benefit from being fleshed-out in a docs site. We should set up a Zensical site for sum-buddy to provide more user-friendly guidance.

Dominant language
Python
Stars
3
Forks
0
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/sum-buddy

All issues in Imageomics/sum-buddy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.