Skip to content

Commit 547b9c3

Browse files
authored
reference rendered docs from README (#729)
1 parent 3847095 commit 547b9c3

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ Omicron is open-source. But we're pretty focused on our own goals for the fores
1212

1313
== Documentation
1414

15-
For design and API docs, see the https://rust.docs.corp.oxide.computer/omicron/[generated documentation]. You can generate this yourself with:
15+
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 "./openapi") into an OpenAPI doc generator.
16+
17+
For design and internal Rust API docs, see the https://rust.docs.corp.oxide.computer/omicron/[generated documentation]. You can generate this yourself with:
1618

1719
[source,text]
1820
----

0 commit comments

Comments
 (0)