rhobs / rhobs/observability-operator
Consider using mdox to embed examples in documents
Open
Nobody has claimed this yet.
help wanted
- Dominant language
- Go
- Stars
- 51
- Forks
- 90
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 22
Description
Currently documentation includes snippet from other files in the repo. Consider using mdox to make the embedding easier.
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
Review the repository documentation that currently includes snippets from other files, then compare mdox's embedding approach with the existing workflow. Identify which documentation files and process would change; done means examples are embedded through a maintainable mdox-based setup.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100