Skip to content

Commit

Permalink
[graphql/rpc] Auto create markdown doc from examples (MystenLabs#14492)
Browse files Browse the repository at this point in the history
## Description 

As discussed with @stefan-mysten this starts the auto doc workflow
It could be prettier but it gets the ball rolling

## Test Plan 

Manual

---
If your changes are not user-facing and not a breaking change, you can
skip the following section. Otherwise, please indicate what changed, and
then add to the Release Notes section as highlighted during the release
process.

### Type of Change (Check all that apply)

- [ ] protocol change
- [ ] user-visible impact
- [ ] breaking change for a client SDKs
- [ ] breaking change for FNs (FN binary must upgrade)
- [ ] breaking change for validators or node operators (must upgrade
binaries)
- [ ] breaking change for on-chain data layout
- [ ] necessitate either a data wipe or data migration

### Release notes
  • Loading branch information
oxade authored Oct 28, 2023
1 parent aa28957 commit afd352f
Show file tree
Hide file tree
Showing 10 changed files with 1,567 additions and 62 deletions.
10 changes: 10 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,7 @@ json_to_table = { git = "https://github.com/zhiburt/tabled/", rev = "e449317a1c0
leb128 = "0.2.5"
linked-hash-map = "0.5.6"
lru = "0.10"
markdown-gen = "1.2.1"
match_opt = "0.1.2"
mime = "0.3"
mockall = "0.11.4"
Expand Down
3 changes: 3 additions & 0 deletions crates/sui-graphql-rpc/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ edition = "2021"


[dependencies]
anyhow.workspace = true
async-graphql = {workspace = true, features = ["dataloader"] }
async-graphql-axum.workspace = true
async-trait.workspace = true
Expand All @@ -21,6 +22,7 @@ hex.workspace = true
hyper.workspace = true
lru.workspace = true
move-binary-format.workspace = true
markdown-gen.workspace = true
mysten-metrics.workspace = true
move-core-types.workspace = true
once_cell.workspace = true
Expand All @@ -33,6 +35,7 @@ serde.workspace = true
serde_json.workspace = true
serde_with.workspace = true
serde_yaml.workspace = true
similar.workspace = true
sui-types.workspace = true
telemetry-subscribers.workspace = true
tracing.workspace = true
Expand Down
Loading

0 comments on commit afd352f

Please sign in to comment.