READMEs · Developer infrastructure
Linkerd README
Linkerd uses its README to orient users to the project and link them into setup and reference materials.
Our interpretation
Useful when you are building…
Use as a reference when explaining Linkerd or a comparable developer infrastructure product to technical users.
Observed in the source
Patterns and sections
## Repo layout
Gives the README a dedicated ## repo layout section, making this topic discoverable from the project entry page.
## Quickstart and documentation
Provides a named route into setup or a first working use of the project.
## Working in this repo
Gives the README a dedicated ## working in this repo section, making this topic discoverable from the project entry page.
Section labels refer to the reviewed public source. Visual design and mobile behavior of the external page were not evaluated.
Adaptation ideas
What to apply to your own product
- Name the primary user outcome before listing implementation details, then route readers to the exact setup or reference section.
- Separate trying the project, deploying it and contributing so each audience can choose a clear next step.
Tradeoff to consider
A repository README provides a compact public entry point, but it cannot replace current product documentation or a guided in-product setup.
Starting route
Start with the README's ## Repo layout section, then follow its linked documentation before adopting a comparable structure.
Source and version
- Linkerd README at 28fefed6669bcadbce60bb025669e084cc58e1bb ↗https://github.com/linkerd/linkerd2/blob/28fefed6669bcadbce60bb025669e084cc58e1bb/README.md
Reviewed README at commit 28fefed6669bcadbce60bb025669e084cc58e1bb. The linked file is pinned to that revision; the live repository may change.
Retrieved with Firecrawl. Content reviewed; product not installed or tested. Annotations are original editorial analysis.