Skip to content

reference rendered docs from README #729

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
merged 2 commits into from
Mar 7, 2022
Merged

reference rendered docs from README #729

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ec8c4c
reference rendered docs from README
davepacheco Mar 7, 2022
032efa6
fix adoc
davepacheco Mar 7, 2022
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: 3 additions & 1 deletion README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Omicron is open-source. But we're pretty focused on our own goals for the fores

== Documentation

For design and API docs, see the https://rust.docs.corp.oxide.computer/omicron/[generated documentation]. You can generate this yourself with:
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.

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

[source,text]
----
Expand Down