TEN-framework / TEN-framework/ten-framework
API documentation improvements
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 11.1k
- Forks
- 1.4k
- Avg merge
- 2d 15m
- Merged PRs (30d)
- 22
Description
- Replace generic examples (foo, bar) with real use cases
- Document tman command usage with practical examples
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Locate the API documentation and the existing tman command usage documentation first. Replace generic foo/bar examples with practical use cases and add practical tman examples; done means both requested documentation improvements are present and the examples accurately reflect the documented usage.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100