[docs-agent] Add HyperCore private-preview docs (hidden) - #1488
Merged
Conversation
Apply the docs-repo-overlay package from abdulmanan-creator/alchemy-hypercore-docs. Every nav entry stays hidden: true; inline OpenRPC methods and pending-confirmation placeholders are preserved as-is per the author's request. Refs DOCS-167 Requested-by: @abdulmanan-creator
🔗 Preview Mode
|
Per @dslovinsky review: remove 67 redundant hidden: true lines from HyperCore nav entries, keeping the flag only on the four net-new top-level sections (Subscription API Endpoints, gRPC, Chain API, Data API). Fern inherits hidden: true down the tree. Also swap - to * unordered-list markers in the three WebSocket pages flagged by remark-lint-unordered-list-marker-style. Refs DOCS-167 Requested-by: @abdulmanan-creator
Per @SahilAujla review: escape [ in table-cell field paths (levels[] etc.) on bbo.mdx and l2-book.mdx to clear remark-lint-no-undefined-references (8 warnings). Rerun prettier on scripts/link-check-slack.ts to clear the pre-existing formatting failure that made pnpm run lint exit non-zero. After this commit pnpm run lint reports 0 errors; the 6 remaining warnings are pre-existing on main and unrelated to this PR. Refs DOCS-167 Requested-by: @abdulmanan-creator
…block rendering Fern's docs-site returns HTTP 500 on OpenRPC method pages when the spec has no servers array. All other chain OpenRPC specs in the repo have at least one server URL; hypercore-chain.yaml was the only one without and was breaking every hl_* method page (e.g. hl-batch-clearinghouse-states, hl-get-block, etc). Mirror the same Provisional base URL placeholder that the REST OpenAPI spec (src/openapi/hypercore/hypercore.yaml) already uses; the confirmed host can be swapped in later without any structural change. Refs DOCS-167 Requested-by: @abdulmanan-creator
SahilAujla
approved these changes
Jul 30, 2026
… slugs, absolute links, expanded content Applies the regenerated overlay from abdulmanan-creator/alchemy-hypercore-docs (docs-repo-overlay/): * Terminology sweep: checkpoint -> cursor (194 occurrences). Page renamed timestamps-checkpoints-and-replay.mdx -> timestamps-cursors-and-replay.mdx. * Explicit slugs added (19), so URLs are hypercore, hypercore-grpc, l2-book, l2-book-diff, l4-book-updates, stream-l2-book, stream-l4-book-updates, hypercore-and-hyperevm, markets-assets-and-dexes, stream-an-l2-order-book, active-asset-context, etc. instead of auto-generated hyper-core-g-rpc / l-2-book slugs. * 60 markdown links and 5 card links converted from relative .mdx paths to absolute /docs/... URLs to fix 404s. * Data API overview rebuilt as a hub with surface cards and a need-to-surface table. * Content expansion on block structure, StreamBlocks, gRPC overview, and historical data. * Maturity caveats added on the L4 pages, all-candles, and funding. * Prior two fixes are already mirrored in the overlay: JSON-RPC servers block and escaped brackets in the BBO and L2 field tables. * docs.yml patch re-applied; hidden: true trimmed back down to the four net-new top-level sections (Subscription API Endpoints, gRPC, Chain API, Data API) after the patch reintroduced them per-page. * Re-swept 8 remaining '-' unordered list markers to '*' in l2-book.mdx, l2-book-diff.mdx, l4-book-updates.mdx. Left as-is per author constraints: inline OpenRPC methods, and the pending-confirmation placeholders on hosts, auth, retention, limits, and gRPC message stubs. Local checks all green: generate:rpc, generate:rest, validate:rpc, validate:rest, validate:docs-yml, pnpm run lint (0 errors, 6 warnings; all pre-existing on main). Refs DOCS-167 Requested-by: @abdulmanan-creator
SahilAujla
approved these changes
Jul 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the HyperCore private-preview documentation package supplied by @abdulmanan-creator via the public overlay repo
abdulmanan-creator/alchemy-hypercore-docs. The overlay was designed to drop directly intoalchemyplatform/docs, andcontent/docs.yml.patchapplies cleanly withpatch -p1.Scope of the drop:
src/openapi/hypercore/hypercore.yaml), historical data, concepts, guides.src/openrpc/chains/hypercore-chain/hypercore-chain.yaml), guides.preview-notice*.mdxsnippets referenced by the pages.Preview posture
Every nav entry landed in this PR carries
hidden: true(71 new nav entries, 71hidden: trueflags). None of this content is discoverable through sidebar or search until we explicitly unhide. Author-provided direct links will be needed to reach it once the preview deploy is up.Author constraints honored
Per the request in the Slack thread:
hidden: true. No entries were unhidden or moved.src/openrpc/chains/hypercore-chain/hypercore-chain.yaml) defines its methods inline rather than via a_componentsgroup. Left as-is — the file generates and validates cleanly.Local checks
Run against this branch on top of
main:pnpm run generate:rest— passes (79 upstream warnings unchanged)pnpm run generate:rpc— passes (content/api-specs/chains/hypercore-chain.jsongenerated)pnpm run validate:rest—Woohoo! Your API description is valid.pnpm run validate:rpc—Successfully validated chains OpenRPC specspnpm run validate:docs-yml—Successfully validated content/docs.ymlpnpm run lint— same pre-existing Prettier failure inscripts/link-check-slack.tsthat Abdul flagged; unrelated to this PR.lycheelink-check is likely to report 404s on the new per-method Daikon-generated pages (/docs/chains/.../<method>and/docs/reference/hypercore-*) until a post-launch Daikon run materializes them. Everything's hidden so end users are not affected — happy to add narrowlychee.tomlexcludes if reviewers want to keep CI clean.Note for reviewers
pnpm run lintsurfaces 22 warnings (0 errors) in the new files — mostlyremark-lint-unordered-list-marker-style(-vs*bullets) andremark-lint-no-undefined-referencesfrom bracketed-index notation in table cells (e.g.levels[][]). All are warnings, not errors, so lint still passes at the exit-code level except for the pre-existingscripts/link-check-slack.tsissue. Per the author's request I have not modified the copy; happy to sweep as a follow-up if you prefer.Linear
DOCS-167 — https://linear.app/alchemyapi/issue/DOCS-167/add-hypercore-private-preview-docs-hidden-overlay-from-abdulmanan
Requested by
@abdulmanan-creator (via Slack thread)