Migrate curated Hiro docs into Stacks docs#1847
Conversation
|
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 |
|
@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 |
|
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. |
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:
docs/reference/SUMMARY.md./hirosubtree.What Changed
docs/buildThis PR adds a new first-class
Chainhookssection to the build space.New pages:
docs/build/chainhooks/overview.mddocs/build/chainhooks/quickstart.mddocs/build/chainhooks/create.mddocs/build/chainhooks/fetch.mddocs/build/chainhooks/update.mddocs/build/chainhooks/evaluate.mddocs/build/chainhooks/secrets.mddocs/build/chainhooks/faq.mddocs/build/chainhooks/migration.mddocs/build/chainhooks/reference/README.mddocs/build/chainhooks/reference/filters.mddocs/build/chainhooks/reference/options.mddocs/build/chainhooks/reference/payload-anatomy.mdThis PR also adds a new first-class
Contract Monitoringsection to the build space.New pages:
docs/build/contract-monitoring/README.mddocs/build/contract-monitoring/create-alert.mdThis PR adds selected Hiro guides into
More Guides.New pages:
docs/build/more-guides/build-an-nft-marketplace.mddocs/build/more-guides/build-a-decentralized-kickstarter.mddocs/build/more-guides/no-loss-lottery.mddocs/build/more-guides/using-clarity-values.mdThis 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.mddocs/build/get-started/clarity-crash-course.mddocs/build/get-started/create-a-token/fungible-tokens.mddocs/build/get-started/create-a-token/non-fungible-tokens.mddocs/build/get-started/developer-quickstart.mddocs/build/get-started/path-to-production.mddocs/build/stacks-devtools-catalog.mdThis 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.mddocs/build/more-guides/bridging-usdcx.mddocs/build/more-guides/sbtc/sbtc-builder-quickstart.mddocs/referenceThis PR adds shared Hiro API guidance pages at the root of the API reference section.
New pages:
docs/reference/api/api-keys.mddocs/reference/api/rate-limits.mddocs/reference/api/response-headers.mdThis PR adds a first-class
Stacks Blockchain APIsection 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.mddocs/reference/api/stacks-blockchain-api/usage.mddocs/reference/api/stacks-blockchain-api/architecture.mddocs/reference/api/stacks-blockchain-api/pagination.mddocs/reference/api/stacks-blockchain-api/nonce-handling.mddocs/reference/api/stacks-blockchain-api/requesting-proofs.mddocs/reference/.gitbook/assets/stacks-blockchain-api-architecture.svgThis PR adds a first-class
Chainhooks APIsection.New pages:
docs/reference/api/chainhooks-api/README.mddocs/reference/api/chainhooks-api/usage.mdThis PR adds a first-class
Token Metadata APIsection.New pages:
docs/reference/api/token-metadata-api/README.mddocs/reference/api/token-metadata-api/usage.mdThis PR adds a first-class
Signer Metrics APIsection.New pages:
docs/reference/api/signer-metrics-api/README.mddocs/reference/api/signer-metrics-api/usage.mdThis 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.mddocs/reference/api/stacks-node-rpc/README.mdThis PR also fixes existing broken links in older reference landing and rollout pages.
Broken-link cleanup in reference:
docs/reference/README.mddocs/reference/node-operations/signer-configuration.mddocs/reference/nakamoto-upgrade/nakamoto-rollout-plan/nakamoto-for-exchanges.mddocs/operateThis 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.mddocs/tutorialsThis PR fixes the broken landing card link for the Bitcoin Primer tutorial.
Updated pages:
docs/tutorials/README.mddocs/press-and-reportsThis 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.mddocs/press-and-reports/press-and-top-links/2025/README.mdContent 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.soruntime endpoints were retained where they are still the current product endpoints.stx-labsor@stacksdestinations where those moves are already live./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:
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-dereferencedchainhooks-apitoken-metadata-apisigner-metrics-apiThe 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-apitoken-metadata-apisigner-metrics-apiPreview / Review Guidance
GitBook revision previews are available on this PR for the affected spaces:
docs/builddocs/referencedocs/operateThe fastest review path is:
Follow-Up Work
Follow-up work that is intentionally not part of this PR:
Validation
Manual validation completed for this branch:
/hirosubtree./broken/pages/...placeholders in the edited pages were removed.docs.hiro.sowhere an in-site replacement now exists.docs/build,docs/reference, anddocs/operate.