Skip to content

Commit

Permalink
task(devx): Re-added GraphQL docs (#3959)
Browse files Browse the repository at this point in the history
* task(devx): Re-added GraphQL docs

* task(devx): fix link

* fix link
  • Loading branch information
lucas-tortora authored Nov 12, 2024
1 parent d59008e commit aa1524f
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 20 deletions.
11 changes: 3 additions & 8 deletions docs/content/developer/getting-started/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,11 @@ The guides in this section will guide you as you start your IOTA Rebased journey
by [setting up your development environment](iota-environment.mdx), and then move on
to [install IOTA](install-iota.mdx).

## GraphQL queries

[//]: # (## GraphQL queries)
Use the GraphQL service for IOTA RPC to interact with on-chain data.

[//]: # ()

[//]: # (Use the GraphQL service for IOTA RPC to interact with on-chain data. )

[//]: # ()

[//]: # (Go to [Query IOTA RPC with GraphQL](getting-started/graphql-rpc.mdx).)
Go to [Query IOTA RPC with GraphQL](graphql-rpc.mdx).

## What's Next?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ It is an error to apply both a `first` and a `last` limit.

### Examples

To see these principles put into practice, consult the examples for [paginating forwards](getting-started/graphql-rpc.mdx#paginating-checkpoints-forward-five-at-a-time-page-forward) and [paginating backwards](getting-started/graphql-rpc.mdx#paginating-checkpoints-backwards-five-at-a-time-page-back) in the getting started guide.
To see these principles put into practice, consult the examples for [paginating forwards](getting-started/graphql-rpc.mdx#paginating-checkpoints-forward-five-at-a-time) and [paginating backwards](getting-started/graphql-rpc.mdx#paginating-checkpoints-backwards-five-at-a-time) in the getting started guide.

## Limits

Expand Down
10 changes: 5 additions & 5 deletions docs/content/references/iota-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
title: IOTA RPC
---

[//]: # (:::info)
:::info

[//]: # ()
[//]: # (The IOTA RPC is upgrading from JSON-RPC to GraphQL. See [GraphQL for IOTA RPC](../developer/_graphql-rpc.mdx) for more information.)

[//]: # ()
[//]: # (:::)
The IOTA RPC is upgrading from JSON-RPC to GraphQL. See [GraphQL for IOTA RPC](../developer/graphql-rpc.mdx) for more information.


:::

_IOTAJSON_ is a JSON-based format with restrictions that allow IOTA to align JSON inputs more closely with Move call arguments.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: GraphQL is a public service for the IOTA RPC that enables you to ef

GraphQL for the IOTA RPC is a public service that enables interacting with the IOTA [network](https://iota.io/networkinfo).

To get started with GraphQL for the IOTA RPC, check out the [Getting Started](../developer/getting-started/_graphql-rpc.mdx) guide. If you'd like to learn more about the concepts used in the GraphQL service, check out the [GraphQL](../developer/_graphql-rpc.mdx) for IOTA RPC concepts page.
To get started with GraphQL for the IOTA RPC, check out the [Getting Started](../developer/getting-started/graphql-rpc.mdx) guide. If you'd like to learn more about the concepts used in the GraphQL service, check out the [GraphQL](../developer/graphql-rpc.mdx) for IOTA RPC concepts page.

## Key Types

Expand All @@ -19,6 +19,6 @@ All GraphQL API elements are accessible via the left sidebar, the following are

## Related links

- [GraphQL migration](../developer/advanced/_graphql-migration.mdx): Migrating to GraphQL guides you through migrating IOTA RPC projects from JSON-RPC to GraphQL.
- [GraphQL quick-start](../developer/getting-started/_graphql-rpc.mdx): Querying IOTA RPC with GraphQL gets you started using GraphQL to query the IOTA RPC for on-chain data.
- [GraphQL concepts](../developer/_graphql-rpc.mdx): GraphQL for IOTA RPC examines the elements of GraphQL that you should know to get the most from the service.
- [GraphQL migration](../developer/advanced/graphql-migration.mdx): Migrating to GraphQL guides you through migrating IOTA RPC projects from JSON-RPC to GraphQL.
- [GraphQL quick-start](../developer/getting-started/graphql-rpc.mdx): Querying IOTA RPC with GraphQL gets you started using GraphQL to query the IOTA RPC for on-chain data.
- [GraphQL concepts](../developer/graphql-rpc.mdx): GraphQL for IOTA RPC examines the elements of GraphQL that you should know to get the most from the service.
4 changes: 2 additions & 2 deletions docs/content/sidebars/references.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const references = [
id: 'references/iota-api',
},
items: [
/*{
{
type: 'category',
label: 'GraphQL',
link: {
Expand All @@ -31,7 +31,7 @@ const references = [
dirName: 'references/iota-api/iota-graphql/reference',
},
],
},*/
},
{
type: 'link',
label: 'JSON-RPC',
Expand Down

0 comments on commit aa1524f

Please sign in to comment.