Skip to content

Commit b6e9078

Browse files
authored
move relevant docs from RFDs 48, 61 into Omicron (#6206)
1 parent cf0b0fd commit b6e9078

File tree

3 files changed

+256
-1
lines changed

3 files changed

+256
-1
lines changed

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Omicron is open-source. But we're pretty focused on our own goals for the forese
1414

1515
https://docs.oxide.computer/api[Docs are automatically generated for the public (externally-facing) API] based on the OpenAPI spec that itself is automatically generated from the server implementation. You can generate your own docs for either the public API or any of the internal APIs by feeding the corresponding OpenAPI specs (in link:./openapi[]) into an OpenAPI doc generator.
1616

17-
There are some internal design docs in the link:./docs[] directory.
17+
There are some internal design docs in the link:./docs[] directory. You might start with link:./docs/control-plane-architecture.adoc[].
1818

1919
For more design documentation and internal Rust API docs, see the https://rust.docs.corp.oxide.computer/omicron/[generated Rust documentation]. You can generate this yourself with:
2020

docs/architecture-rev-2024-08-01.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)