Skip to content
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.

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

[GraphQL/Docs][RFC] Move GraphQL References out from Sui API heading #16019

Merged
merged 1 commit into from
Jan 31, 2024

Conversation

amnn
Copy link
Contributor

@amnn amnn commented Jan 31, 2024

Description

Create distinct top-level headings under "References" for "Sui JSON-RPC API" and "Sui GraphQL API". This was to avoid a couple of confusing aspects of the previous IA:

  • It was unclear when reading "Sui API" what that was referring to (GraphQL or JSON-RPC).
  • The "RPC Best Practices" page (intended for JSON-RPC) was confusingly next to the GraphQL references.

Test Plan

docs/site$ pnpm build && pnpm start
  • 👀

Create distinct top-level headings under "References" for "Sui
JSON-RPC API" and "Sui GraphQL API". This was to avoid a couple of
confusing aspects of the previous IA:

- It was unclear when reading "Sui API" what that was referring
  to (GraphQL or JSON-RPC).
- The "RPC Best Practices" page (intended for JSON-RPC) was
  confusingly next to the GraphQL references.

Test Plan:

```
docs/site$ pnpm build && pnpm start
```

+ 👀
Copy link

vercel bot commented Jan 31, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
explorer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2024 1:49am
multisig-toolkit ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2024 1:49am
mysten-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2024 1:49am
sui-core ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2024 1:49am
sui-kiosk ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2024 1:49am
sui-typescript-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 31, 2024 1:49am

@amnn amnn merged commit a7dba36 into main Jan 31, 2024
41 checks passed
@amnn amnn deleted the amnn/gql-docs-ref-up branch January 31, 2024 12:08
amnn added a commit that referenced this pull request Jan 31, 2024
)

## Description

Adding documentation on how Connections work, including cursors,
consistency, available range, page limits, and some examples of forward
and backward pagination.

## Test Plan

```
docs/site$ pnpm build && pnpm start
```

+ 👀

## Stack

- #16019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants