Skip to content

Commit

Permalink
update cat-gateway docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr-Leshiy committed Dec 12, 2023
1 parent 301d953 commit c59fdef
Show file tree
Hide file tree
Showing 7 changed files with 68 additions and 48 deletions.
2 changes: 1 addition & 1 deletion docs/Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api/.pages
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
nav:
- index.md
- 'Catalyst gateway': catalyst-gateway.md
- 'Catalyst gateway': cat-gateway
4 changes: 4 additions & 0 deletions docs/src/api/cat-gateway/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
nav:
- index.md
- 'Rust docs': rust.md
- 'OpenAPI docs': openapi.md
5 changes: 5 additions & 0 deletions docs/src/api/cat-gateway/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
icon: material/gate
---

# Catalyst Gateway API
11 changes: 11 additions & 0 deletions docs/src/api/cat-gateway/openapi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
icon: material/server
---

# OpenAPI docs

```JSON
{
"name": "Alex",
}
```
46 changes: 46 additions & 0 deletions docs/src/api/cat-gateway/rust.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
icon: material/language-rust
---

<!-- cspell: words RUSTDOC graphviz -->

# Rust docs

<!-- markdownlint-disable no-inline-html -->
<iframe src="../rust-docs/index.html" title="RUSTDOC Documentation" style="height:800px;width:100%;"></iframe>

[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
```
46 changes: 0 additions & 46 deletions docs/src/api/catalyst-gateway.md

This file was deleted.

0 comments on commit c59fdef

Please sign in to comment.