Skip to content

Commit d18289f

Browse files
authored
docs(readme): link the documentation site (#813)
## Summary ### Why? The documentation site is live at https://uber.github.io/submitqueue/ (#812), but the README links to it only through a badge. ### What? - Add a **Documentation** link under the intro paragraphs. - Open the Documentation section with a sentence pointing at the site; the table of in-repo documents stays. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent f56154f commit d18289f

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ SubmitQueue is a high-performance speculative submission queue that keeps your t
1010

1111
Designed for large monorepos and fast-moving teams where concurrent changes can introduce subtle conflicts and destabilize builds.
1212

13+
**Documentation:** [uber.github.io/submitqueue](https://uber.github.io/submitqueue/) has guides, design docs (RFCs) and search.
14+
1315
## Repository layout
1416

1517
Cross-domain Go code (errors, metrics, consumer framework, HTTP helpers, shared entities, shared extension contracts) lives under [`platform/`](platform/README.md). Each product domain has its own tree (`submitqueue/`, `stovepipe/`, …). Multi-service domains may split into `gateway/` and `orchestrator/`; single-service domains keep controllers directly under the domain root. Stovepipe currently exposes ingestion behavior and runs its own queue pipeline. See [AGENTS.md](AGENTS.md) for conventions and import paths.
@@ -44,6 +46,8 @@ The queue's own logic is real in all three: validation, batching, conflict analy
4446

4547
## Documentation
4648

49+
The documentation site at [uber.github.io/submitqueue](https://uber.github.io/submitqueue/) renders everything under [`doc/`](doc/). The same documents, in the repository:
50+
4751
| Document | Description |
4852
|----------|-------------|
4953
| [Quickstart](doc/howto/QUICKSTART.md) | Run the stack and land changes — fake, local git, or GitHub |

0 commit comments

Comments
 (0)