Skip to content

Migrate curated Hiro docs into Stacks docs#1847

Draft
huth-stacks wants to merge 4 commits intomasterfrom
codex/hiro-docs-migration-v2
Draft

Migrate curated Hiro docs into Stacks docs#1847
huth-stacks wants to merge 4 commits intomasterfrom
codex/hiro-docs-migration-v2

Conversation

@huth-stacks
Copy link
Collaborator

@huth-stacks huth-stacks commented Mar 20, 2026

Summary

This PR migrates the approved Hiro documentation into first-class Stacks docs locations and removes the need to send users to separate Hiro-hosted docs for the covered topics.

The migration is GitBook-native:

  • API sections are represented as landing pages plus GitBook OpenAPI blocks in docs/reference/SUMMARY.md.
  • Tooling and guide content is moved into existing Stacks docs spaces instead of a temporary /hiro subtree.
  • Existing Stacks docs pages that previously pointed to Hiro docs are updated to point to the new in-site destinations.
  • Existing broken GitBook placeholder links encountered during the migration were repaired so the PR does not leave known broken navigation behind.

What Changed

docs/build

This PR adds a new first-class Chainhooks section to the build space.

New pages:

  • docs/build/chainhooks/overview.md
  • docs/build/chainhooks/quickstart.md
  • docs/build/chainhooks/create.md
  • docs/build/chainhooks/fetch.md
  • docs/build/chainhooks/update.md
  • docs/build/chainhooks/evaluate.md
  • docs/build/chainhooks/secrets.md
  • docs/build/chainhooks/faq.md
  • docs/build/chainhooks/migration.md
  • docs/build/chainhooks/reference/README.md
  • docs/build/chainhooks/reference/filters.md
  • docs/build/chainhooks/reference/options.md
  • docs/build/chainhooks/reference/payload-anatomy.md

This PR also adds a new first-class Contract Monitoring section to the build space.

New pages:

  • docs/build/contract-monitoring/README.md
  • docs/build/contract-monitoring/create-alert.md

This PR adds selected Hiro guides into More Guides.

New pages:

  • docs/build/more-guides/build-an-nft-marketplace.md
  • docs/build/more-guides/build-a-decentralized-kickstarter.md
  • docs/build/more-guides/no-loss-lottery.md
  • docs/build/more-guides/using-clarity-values.md

This PR updates existing Stacks build pages so they point to the newly migrated Hiro content instead of old external docs.

Updated pages:

  • docs/build/SUMMARY.md
  • docs/build/get-started/clarity-crash-course.md
  • docs/build/get-started/create-a-token/fungible-tokens.md
  • docs/build/get-started/create-a-token/non-fungible-tokens.md
  • docs/build/get-started/developer-quickstart.md
  • docs/build/get-started/path-to-production.md
  • docs/build/stacks-devtools-catalog.md

This PR also fixes existing broken links in user-facing build pages that were outside the imported Hiro content itself.

Broken-link cleanup in build:

  • docs/build/README.md
  • docs/build/more-guides/bridging-usdcx.md
  • docs/build/more-guides/sbtc/sbtc-builder-quickstart.md

docs/reference

This PR adds shared Hiro API guidance pages at the root of the API reference section.

New pages:

  • docs/reference/api/api-keys.md
  • docs/reference/api/rate-limits.md
  • docs/reference/api/response-headers.md

This PR adds a first-class Stacks Blockchain API section to the reference space, following the GitBook pattern already used in the repo for other APIs.

New pages:

  • docs/reference/api/stacks-blockchain-api/README.md
  • docs/reference/api/stacks-blockchain-api/usage.md
  • docs/reference/api/stacks-blockchain-api/architecture.md
  • docs/reference/api/stacks-blockchain-api/pagination.md
  • docs/reference/api/stacks-blockchain-api/nonce-handling.md
  • docs/reference/api/stacks-blockchain-api/requesting-proofs.md
  • docs/reference/.gitbook/assets/stacks-blockchain-api-architecture.svg

This PR adds a first-class Chainhooks API section.

New pages:

  • docs/reference/api/chainhooks-api/README.md
  • docs/reference/api/chainhooks-api/usage.md

This PR adds a first-class Token Metadata API section.

New pages:

  • docs/reference/api/token-metadata-api/README.md
  • docs/reference/api/token-metadata-api/usage.md

This PR adds a first-class Signer Metrics API section.

New pages:

  • docs/reference/api/signer-metrics-api/README.md
  • docs/reference/api/signer-metrics-api/usage.md

This PR updates the existing Node RPC page to better distinguish the self-hosted Node RPC API from the Hiro-hosted indexed Stacks Blockchain API.

Updated pages:

  • docs/reference/SUMMARY.md
  • docs/reference/api/stacks-node-rpc/README.md

This PR also fixes existing broken links in older reference landing and rollout pages.

Broken-link cleanup in reference:

  • docs/reference/README.md
  • docs/reference/node-operations/signer-configuration.md
  • docs/reference/nakamoto-upgrade/nakamoto-rollout-plan/nakamoto-for-exchanges.md

docs/operate

This PR updates the signer monitoring guide to point readers to the new Signer Metrics API reference.

Updated pages:

  • docs/operate/run-a-signer/how-to-monitor-signer.md

docs/tutorials

This PR fixes the broken landing card link for the Bitcoin Primer tutorial.

Updated pages:

  • docs/tutorials/README.md

docs/press-and-reports

This PR fixes broken monthly index links in the press-and-top-links archives.

Updated pages:

  • docs/press-and-reports/press-and-top-links/2024/README.md
  • docs/press-and-reports/press-and-top-links/2025/README.md

Content Treatment

This migration is not a raw dump of the Hiro docs repo.

The content in this PR was curated and normalized for GitBook:

  • Hiro MDX content was converted into GitBook-compatible Markdown.
  • API docs were migrated as prose landing pages and usage pages, not as per-endpoint wrapper files.
  • Internal links were updated to point to final Stacks docs destinations.
  • Hiro branding was preserved where appropriate so the APIs still read as Hiro-hosted products inside the Stacks docs experience.
  • Existing hiro.so runtime endpoints were retained where they are still the current product endpoints.
  • Some repo and package references were updated to current stx-labs or @stacks destinations where those moves are already live.
  • Existing Stacks docs references to old Hiro docs were replaced where this PR creates a first-class in-site destination.
  • Existing /broken/pages/... GitBook placeholders were replaced with live destinations where the correct targets could be identified confidently.

Deliberately Excluded

This PR does not migrate everything from Hiro docs.

Deliberately excluded from this PR:

  • Ordinals API docs.
  • Runes API docs.
  • Bitcoin Indexer docs.
  • Platform API docs.
  • Archive-only Hiro content.
  • Spanish source content from the Hiro repo.

The excluded items were left out on purpose because they are deprecated, deferred, already covered elsewhere in Stacks docs, or are intended to be handled outside the repo through GitBook translations.

GitBook / OpenAPI Notes

This PR adds GitBook OpenAPI entries for the following Hiro API sections:

  • stacks-blockchain-api-dereferenced
  • chainhooks-api
  • token-metadata-api
  • signer-metrics-api

The Stacks Blockchain API content follows the existing baseline established in #1845.

Before merge, GitBook admins should verify that the referenced spec IDs are registered and rendering correctly in the preview for:

  • chainhooks-api
  • token-metadata-api
  • signer-metrics-api

Preview / Review Guidance

GitBook revision previews are available on this PR for the affected spaces:

  • docs/build
  • docs/reference
  • docs/operate

The fastest review path is:

  1. Review the rendered GitBook previews for navigation, layout, and page rendering.
  2. Review this GitHub PR for the full content delta.
  3. Confirm the new API sections render correctly once the GitBook OpenAPI specs are available.

Follow-Up Work

Follow-up work that is intentionally not part of this PR:

  • Spanish publication through GitBook Translations after English approval.
  • Any GitBook-side OpenAPI registration or correction needed for the new reference sections.
  • Any future cleanup of stale but non-broken links outside this migration scope.

Validation

Manual validation completed for this branch:

  • Verified the PR no longer includes the earlier internal migration planning document.
  • Verified the migration uses first-class docs locations instead of a temporary /hiro subtree.
  • Verified relative links across the migrated and touched pages resolve locally.
  • Verified the current /broken/pages/... placeholders in the edited pages were removed.
  • Verified migrated and touched pages no longer point to docs.hiro.so where an in-site replacement now exists.
  • Verified the branch has live GitBook revision previews for docs/build, docs/reference, and docs/operate.

@wileyj
Copy link
Contributor

wileyj commented Mar 20, 2026

54 files 😭

I'll start picking away @huth-stacks

@alexis-stacks
Copy link
Collaborator

54 files 😭

I'll start picking away @huth-stacks

Ah fyi I added you too early maybe? I don’t think it’s ready for a review until he promotes from draft. Sorry!

@wileyj
Copy link
Contributor

wileyj commented Mar 21, 2026

54 files 😭
I'll start picking away @huth-stacks

Ah fyi I added you too early maybe? I don’t think it’s ready for a review until he promotes from draft. Sorry!

totally fine! better to start checking early when there are this many files

@huth-stacks
Copy link
Collaborator Author

@wileyj i am happy to decompose this into many section by section PRs for you as well. My goal is to make this as painless as possible

@alexis-stacks
Copy link
Collaborator

I discussed with @wileyj today and confirmed that this effort should be focused on migration rather than page-level accuracy auditing for this pass, but @huth-stacks we should still glance through these to sanity check the content, even if the top-level goal is just getting them into the appropriate information architecture locations for the Stacks docs.

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.

3 participants