Document transitions between types of config builders
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 7.6k
- Forks
- 896
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 39
Description
In going from a ConfigBuilder to a ServerConfig or ClientConfig, there are a number of other possible builder types along the way, and it's important to go from one to the next in the right order. It would be great if one of the doc pages (probably ConfigBuilder) had a diagram of the paths that building can take and what is yielded at each step; then each of the Builder types could link back to that explanation.
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
Start with the ConfigBuilder, ServerConfig, ClientConfig, and other Builder type documentation to map the valid transition paths and what each step yields. Add a diagram to the ConfigBuilder documentation or another suitable doc page, and link each Builder type back to it. Done means the ordering and resulting types are clear from the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100