vectordotdev / vectordotdev/vector
Add `vector generate` and `vector test` snippets to each component's reference page
Open
Nobody has claimed this yet.
domain: external docs
- Dominant language
- Rust
- Stars
- 22.6k
- Forks
- 2.3k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 146
Description
To drive home the development workflow we want users to adopt, I think it would be nice to somehow include the new vector generate and vector test command on the reference page. Maybe this only makes sense for reshaping transforms, but it's worth thinking about how these fit into the overall docs.
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 component reference pages and the vector generate and vector test commands named in the issue. Clarify whether snippets belong on every page or only reshaping transforms; done means the agreed reference pages demonstrate the development workflow.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100