Skip to content

docs(readme): link the documentation site #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
behinddwalls merged 1 commit into from
Oct 8, 2026
Merged

docs(readme): link the documentation site #813

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ SubmitQueue is a high-performance speculative submission queue that keeps your t

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

**Documentation:** [uber.github.io/submitqueue](https://uber.github.io/submitqueue/) has guides, design docs (RFCs) and search.

## Repository layout

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.
Expand Down Expand Up @@ -44,6 +46,8 @@ The queue's own logic is real in all three: validation, batching, conflict analy

## Documentation

The documentation site at [uber.github.io/submitqueue](https://uber.github.io/submitqueue/) renders everything under [`doc/`](doc/). The same documents, in the repository:

| Document | Description |
|----------|-------------|
| [Quickstart](doc/howto/QUICKSTART.md) | Run the stack and land changes — fake, local git, or GitHub |
Expand Down
Loading