Skip to content

docs: Fix indexer API to v4, update runbook for docs restructure #131

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.

Sign up for GitHub

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

Open
adamreynolds-io wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Fix indexer API to v4, update runbook for docs restructure #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion COMPATIBILITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Release notes: [v4.0.4](https://github.com/midnightntwrk/midnight-js/releases/ta
| Service | Preview | Preprod | Mainnet |
|---|---|---|---|
| Node RPC | [rpc.preview.midnight.network](https://rpc.preview.midnight.network) | [rpc.preprod.midnight.network](https://rpc.preprod.midnight.network) | [rpc.mainnet.midnight.network](https://rpc.mainnet.midnight.network) |
| Indexer GraphQL | [indexer.preview.midnight.network](https://indexer.preview.midnight.network/api/v3/graphql) | [indexer.preprod.midnight.network](https://indexer.preprod.midnight.network/api/v3/graphql) | [indexer.mainnet.midnight.network](https://indexer.mainnet.midnight.network/api/v3/graphql) |
| Indexer GraphQL | [indexer.preview.midnight.network](https://indexer.preview.midnight.network/api/v4/graphql) | [indexer.preprod.midnight.network](https://indexer.preprod.midnight.network/api/v4/graphql) | [indexer.mainnet.midnight.network](https://indexer.mainnet.midnight.network/api/v4/graphql) |
| Proof Server | [lace-proof-pub.preview.midnight.network](https://lace-proof-pub.preview.midnight.network) | [lace-proof-pub.preprod.midnight.network](https://lace-proof-pub.preprod.midnight.network) | [lace-proof-pub.mainnet.midnight.network](https://lace-proof-pub.mainnet.midnight.network) |
| Faucet | [faucet.preview.midnight.network](https://faucet.preview.midnight.network) | [faucet.preprod.midnight.network](https://faucet.preprod.midnight.network) | — |
| Block Explorer | [explorer.preview.midnight.network](https://explorer.preview.midnight.network) | [explorer.preprod.midnight.network](https://explorer.preprod.midnight.network) | [explorer.mainnet.midnight.network](https://explorer.mainnet.midnight.network) |
Expand Down
5 changes: 3 additions & 2 deletions docs/refresh-compatibility-matrix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The public endpoints table in COMPATIBILITY.md lists service URLs per network. T

Current pattern:
- Node RPC: `https://rpc.{network}.midnight.network`
- Indexer: `https://indexer.{network}.midnight.network/api/v3/graphql`
- Indexer: `https://indexer.{network}.midnight.network/api/v4/graphql`
- Proof Server: `https://lace-proof-pub.{network}.midnight.network`
- Faucet: `https://faucet.{network}.midnight.network` (testnets only)
- Block Explorer: `https://explorer.{network}.midnight.network`
Expand Down Expand Up @@ -196,7 +196,8 @@ Update `ECOSYSTEM.md` only if:
After the midnight-sdk PR is raised, raise a corresponding PR in the **midnight-docs** repo ([midnightntwrk/midnight-docs](https://github.com/midnightntwrk/midnight-docs)) to reflect the same changes. The following files must stay in sync with `COMPATIBILITY.md` in this repo:

- `docs/relnotes/support-matrix.mdx` — the public compatibility matrix at [docs.midnight.network/relnotes/support-matrix](https://docs.midnight.network/relnotes/support-matrix)
- `docs/relnotes/overview.mdx` — "Latest Stable Release" page with public endpoints and version table
- `docs/relnotes/network.mdx` — "Environments and endpoints" page with per-network service URLs
- `docs/relnotes/overview.mdx` — "Latest Stable Release" hub page (links to support-matrix and network; only update if the release summary text changes)
- `docs/troubleshoot/fix-version-mismatch-errors.mdx` — references ledger version and package names (ensure these match current versions)

The two PRs must be cross-linked:
Expand Down