open-feature / open-feature/flagd
[PROCESS] Deliver comprehensive documentation
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 997
- Forks
- 136
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 11
Description
Idea from @toddbaert:
I would love to see an AI agent supporting a robust research mode attempt to totally rewrite our docs, after prompting it to include all of [the sub-issues]. It would only need to generate a set of markdown documents; with some human reviews it might be adequate.
Contributor guide
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
Begin with the sub-issues referenced in the issue; no files, tests, or entry points are named. Establish the documentation scope and review process, then consider the work complete when the comprehensive markdown rewrite has received human review.
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
- 15/100