vectordotdev / vectordotdev/vector

Adopt documentation style guide for Vector website

Open
#2,357 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

domain: ci have: nice
Dominant language
Rust
Stars
22.6k
Forks
2.3k
Avg merge
1d 7h
Merged PRs (30d)
146

Description

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked pull request discussion and reviewing the linked spellcheck action. Then inspect the Vector website documentation to determine the scope of the style-guide adoption and whether spellchecking should be integrated. Done means the agreed documentation style is applied consistently and the requested spelling checks are in place.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.