update documentation
Open
- Dominant language
- Go
- Stars
- 217
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
Currently the examples and docs are in the readme. Add docs to the mkdocs dir, `docs/`, for the website.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the examples and documentation in README and inspecting the mkdocs docs/ directory. Move the relevant material into the website documentation, with the examples and documented guidance available there rather than only in README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100