Skip to content

docs: correct Stacks API archive prerequisites, add troubleshooting, remove Metadata API archive page#1148

Merged
rafa-stacks merged 2 commits into
mainfrom
archive-tweaks
Jul 24, 2026
Merged

docs: correct Stacks API archive prerequisites, add troubleshooting, remove Metadata API archive page#1148
rafa-stacks merged 2 commits into
mainfrom
archive-tweaks

Conversation

@rafa-stacks

Copy link
Copy Markdown
Collaborator

What & why

Corrects several inaccuracies on the Stacks Blockchain API archive page, adds guidance for post-restore behavior and troubleshooting, and removes the now-obsolete Token Metadata API archive page.

Changes

resources/archive/stacks-api.mdx

  • Block height prerequisite — the API does not require the node to be at the same block height. Reworded to clarify the API's block height can be greater than or equal to the Stacks node's.
  • Archive date compatibility — the Stacks node archive need not match the API archive date. Changed to: the Stacks blockchain archive was created on the same date as, or an earlier date than, the API archive.
  • Postgres restore time — "may take up to an hour" → "may take several hours" depending on database specs and tuning.
  • New "Receiving new blocks" section — explains that once restored and connected to the node, the API begins receiving and accepting new block events, and how to confirm via logs and /extended/v1/status.
  • New "Troubleshooting" section — covers the case where the API stops advancing, with the DB does not contain a parent block at height ... error: its cause (API DB behind the node) and resolution (re-restore so API height ≥ node height, then restart).

Remove Token Metadata API archive page

  • Deleted resources/archive/token-metadata-api.mdx (EN + ES) and removed it from both archive meta.json nav files.

Verification

  • stacks-api.mdx compiles and renders cleanly (200, no MDX errors); new sections present.
  • No dangling references to the removed Metadata API archive page remain; archive nav resolves.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hiro-systems-docs Ready Ready Preview Jul 24, 2026 9:36pm

Request Review

@rafa-stacks
rafa-stacks merged commit eaf3224 into main Jul 24, 2026
0 of 2 checks passed
@rafa-stacks
rafa-stacks deleted the archive-tweaks branch July 24, 2026 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant