Skip to content

Commit c59fdef

Browse files
committed
update cat-gateway docs
1 parent 301d953 commit c59fdef

File tree

7 files changed

+68
-48
lines changed

7 files changed

+68
-48
lines changed

docs/Earthfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ src:
1111
# Now copy into that any artifacts we pull from the builds.
1212
COPY --dir ../+repo-docs/repo /docs/includes
1313
# copy Rust docs
14-
COPY ./../catalyst-gateway+build-hosted/doc /docs/src/api/catalyst-gateway/rust-docs
14+
COPY ./../catalyst-gateway+build-hosted/doc /docs/src/api/cat-gateway/rust-docs
1515

1616
# Build the docs here.
1717
docs:

docs/src/api/.pages

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
nav:
22
- index.md
3-
- 'Catalyst gateway': catalyst-gateway.md
3+
- 'Catalyst gateway': cat-gateway

docs/src/api/cat-gateway/.pages

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
nav:
2+
- index.md
3+
- 'Rust docs': rust.md
4+
- 'OpenAPI docs': openapi.md

docs/src/api/cat-gateway/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
icon: material/gate
3+
---
4+
5+
# Catalyst Gateway API

docs/src/api/cat-gateway/openapi.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
icon: material/server
3+
---
4+
5+
# OpenAPI docs
6+
7+
```JSON
8+
{
9+
"name": "Alex",
10+
}
11+
```

docs/src/api/cat-gateway/rust.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
icon: material/language-rust
3+
---
4+
5+
<!-- cspell: words RUSTDOC graphviz -->
6+
7+
# Rust docs
8+
9+
<!-- markdownlint-disable no-inline-html -->
10+
<iframe src="../rust-docs/index.html" title="RUSTDOC Documentation" style="height:800px;width:100%;"></iframe>
11+
12+
[OPEN FULL PAGE](./rust-docs/index.html)
13+
14+
## Workspace Dependency Graph
15+
16+
```kroki-graphviz
17+
@from_file:./api/cat-gateway/rust-docs/workspace.dot
18+
```
19+
20+
## External Dependencies Graph
21+
22+
```kroki-graphviz
23+
@from_file:./api/cat-gateway/rust-docs/full.dot
24+
```
25+
26+
## Build and Development Dependencies Graph
27+
28+
```kroki-graphviz
29+
@from_file:./api/cat-gateway/rust-docs/all.dot
30+
```
31+
32+
## Module trees
33+
34+
### cat-gateway crate
35+
36+
```rust
37+
{{ include_file('src/api/cat-gateway/rust-docs/cat-gateway.cat-gateway.bin.modules.tree') }}
38+
```
39+
40+
## Module graphs
41+
42+
### cat-gateway crate
43+
44+
```kroki-graphviz
45+
@from_file:./api/cat-gateway/rust-docs/cat-gateway.cat-gateway.bin.modules.dot
46+
```

docs/src/api/catalyst-gateway.md

-46
This file was deleted.

0 commit comments

Comments
 (0)