Add API refrences to site
Open
Documentation
experimental
Site
- Dominant language
- Jupyter Notebook
- Stars
- 30
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
We should generate docs for userale and distill for 2.4.0 and each published version moving forward. Ideally this can be automated such that each time a release is created the generated docs are added to the site
https://docs.python.org/3/library/pydoc.html
https://typedoc.org/
Contributor guide
No contributing guide indexed for this repository
Research direction
No files or tests are named. Start by reading the linked pydoc and TypeDoc references, then locate the site's documentation generation and release automation entry points; done means API documentation for userale and distill is published for 2.4.0 and subsequent releases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, typescript
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100