tailscale / tailscale/tailscale-rs
all: docs
Open
Nobody has claimed this yet.
documentation
enhancement
tech debt
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 61
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 22
Description
- README.md
What this project is- What Tailscale is, how this project relates to the bigger thing
Accurate, current status'hello world' examplelinks to CONTRIBUTING.md, docs.rs, user guide, crates.ioplatforms supportedhow to build, run, test; build requirementssupported Rust versions
- For each crate
- Short README.md
- API docs
- Document language bindings
- CONTRIBUTING.md
Nature of open-sourcenessContributions which are welcomeExpectations for PRs - tests, lints, CI, etc.Expectations/requests for issues- CoC
- how to contact the project
- more on high-level design/arch (#64)
- User docs
check that rustdoc gives a good experiencecheck first page, internal cratesmake things which should be hidden, doc-hidden
launch blog post/short overview to point people at- user guide (probably post-launch)
- Roadmap issue (pinned, linked from README.md)
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 by reading README.md and CONTRIBUTING.md, then review the unchecked documentation items for the crates, language bindings, user guide, Code of Conduct, contact information, architecture, and roadmap. Done means the selected documentation gaps are completed and linked or reflected in the relevant project documents.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100