sillsdev / sillsdev/languageforge-lexbox
polish documentation for lexbox public apis
Open
Nobody has claimed this yet.
📖 MiniLcm
- Dominant language
- C#
- Stars
- 9
- Forks
- 8
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 49
Description
Describe the feature
This requires adding more documentation and examples of how to use our APIs
Who is this feature for?
3rd party developers
Pages affected
Swagger
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
Start with the Swagger documentation for Lexbox and review how its public APIs are currently described. Add documentation and usage examples for third-party developers, then verify that the affected Swagger pages clearly explain the available public APIs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100