indico / indico/ursh

Write Documentation

Open
#5 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
8
Forks
3
PR merge metrics
No merged PRs in 30d

Description

* [x] REST API documentation (Swagger?)
* [ ] Package documentation (Sphinx) - installation, API reference

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the package documentation configuration and any existing Sphinx sources in the repository. Read the current package structure and document installation and the public API; the work is done when those sections are present and the existing REST API documentation remains accounted for.

Written by the indexing model from the issue text.

Assessment

Tech stack
flask, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.