diff --git a/docs/Earthfile b/docs/Earthfile index ce302f5fef9..330fafc4121 100644 --- a/docs/Earthfile +++ b/docs/Earthfile @@ -11,7 +11,7 @@ src: # Now copy into that any artifacts we pull from the builds. COPY --dir ../+repo-docs/repo /docs/includes # copy Rust docs - COPY ./../catalyst-gateway+build-hosted/doc /docs/src/api/catalyst-gateway/rust-docs + COPY ./../catalyst-gateway+build-hosted/doc /docs/src/api/cat-gateway/rust-docs # Build the docs here. docs: diff --git a/docs/src/api/.pages b/docs/src/api/.pages index a6bb24b5d98..a5f6791eb06 100644 --- a/docs/src/api/.pages +++ b/docs/src/api/.pages @@ -1,3 +1,3 @@ nav: - index.md - - 'Catalyst gateway': catalyst-gateway.md \ No newline at end of file + - 'Catalyst gateway': cat-gateway \ No newline at end of file diff --git a/docs/src/api/cat-gateway/.pages b/docs/src/api/cat-gateway/.pages new file mode 100644 index 00000000000..fcb4544c60c --- /dev/null +++ b/docs/src/api/cat-gateway/.pages @@ -0,0 +1,4 @@ +nav: + - index.md + - 'Rust docs': rust.md + - 'OpenAPI docs': openapi.md \ No newline at end of file diff --git a/docs/src/api/cat-gateway/index.md b/docs/src/api/cat-gateway/index.md new file mode 100644 index 00000000000..65bf358322a --- /dev/null +++ b/docs/src/api/cat-gateway/index.md @@ -0,0 +1,5 @@ +--- +icon: material/gate +--- + +# Catalyst Gateway API diff --git a/docs/src/api/cat-gateway/openapi.md b/docs/src/api/cat-gateway/openapi.md new file mode 100644 index 00000000000..eb2a60ff1f9 --- /dev/null +++ b/docs/src/api/cat-gateway/openapi.md @@ -0,0 +1,11 @@ +--- +icon: material/server +--- + +# OpenAPI docs + +```JSON +{ + "name": "Alex", +} +``` \ No newline at end of file diff --git a/docs/src/api/cat-gateway/rust.md b/docs/src/api/cat-gateway/rust.md new file mode 100644 index 00000000000..4ddfc44d3a3 --- /dev/null +++ b/docs/src/api/cat-gateway/rust.md @@ -0,0 +1,46 @@ +--- +icon: material/language-rust +--- + + + +# Rust docs + + + + +[OPEN FULL PAGE](./rust-docs/index.html) + +## Workspace Dependency Graph + +```kroki-graphviz +@from_file:./api/cat-gateway/rust-docs/workspace.dot +``` + +## External Dependencies Graph + +```kroki-graphviz +@from_file:./api/cat-gateway/rust-docs/full.dot +``` + +## Build and Development Dependencies Graph + +```kroki-graphviz +@from_file:./api/cat-gateway/rust-docs/all.dot +``` + +## Module trees + +### cat-gateway crate + +```rust + {{ include_file('src/api/cat-gateway/rust-docs/cat-gateway.cat-gateway.bin.modules.tree') }} +``` + +## Module graphs + +### cat-gateway crate + +```kroki-graphviz +@from_file:./api/cat-gateway/rust-docs/cat-gateway.cat-gateway.bin.modules.dot +``` diff --git a/docs/src/api/catalyst-gateway.md b/docs/src/api/catalyst-gateway.md deleted file mode 100644 index e79572beb97..00000000000 --- a/docs/src/api/catalyst-gateway.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -icon: material/gate ---- - - - -# Catalyst Gateway Rust docs - - - - -[OPEN FULL PAGE](./catalyst-gateway/rust-docs/index.html) - -## Workspace Dependency Graph - -```kroki-graphviz -@from_file:./api/catalyst-gateway/rust-docs/workspace.dot -``` - -## External Dependencies Graph - -```kroki-graphviz -@from_file:./api/catalyst-gateway/rust-docs/full.dot -``` - -## Build and Development Dependencies Graph - -```kroki-graphviz -@from_file:./api/catalyst-gateway/rust-docs/all.dot -``` - -## Module trees - -### cat-gateway crate - -```rust - {{ include_file('src/api/catalyst-gateway/rust-docs/cat-gateway.cat-gateway.bin.modules.tree') }} -``` - -## Module graphs - -### cat-gateway crate - -```kroki-graphviz -@from_file:./api/catalyst-gateway/rust-docs/cat-gateway.cat-gateway.bin.modules.dot -```