tailscale / tailscale/tailscale-rs
docs: add/improve diagrams in ARCHITECTURE.md
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 1.2k
- Forks
- 61
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 22
Description
The single diagram in ARCHITECTURE.md is a Mermaid.js block diagram; it has been a pain to create and modify.
- Convert the existing architecture diagram to a Figma document (or similar)
- Add a Utilities block to the new diagram
- Replace the existing Mermaid.js diagram in ARCHITECTURE.md with an image from the new diagram
- Add area-specific diagrams to each top-level area (API/Language Bindings, Runtime, etc.)
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 ARCHITECTURE.md and inspect the existing Mermaid.js block diagram, then map the top-level areas such as API/Language Bindings and Runtime. Create the replacement diagram with a Utilities block and add area-specific diagrams; done means ARCHITECTURE.md uses the new image and each top-level area has its own diagram.
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
- 38/100