Skip to content

Docs: remove/align orphaned pages so only nav-reachable pages are live #216

@GregTheGreek

Description

@GregTheGreek

Summary

Guiding rule: a docs page should be live only if it's reachable through the website navigation. Today a number of pages are committed to main and served at docs.sprinter.tech (HTTP 200, fully rendered) but are not in the mint.json navigation. They don't appear in the sidebar or search, they're excluded from llms.txt/llms-full.txt, but they're still crawlable by direct URL and by AI/search agents — which surfaces stale/superseded content.

This issue tracks everything that looks inconsistent, found by comparing origin/main (HEAD a66d1e8, the deployed default branch) against the live site and mint.json.

Note: mint.json is auto-generating both the sidebar and llms.txt from its navigation array, so the fix for most items is to either add the page to the nav or remove/unpublish the file (the latter aligns with the rule above).


1. Orphaned ("ghost") pages — live but not in nav

These .mdx files exist on main and return 200 live, but are absent from mint.json navigation. They should be removed/unpublished (or, if intended, added to the nav).

Likely superseded duplicates (the nav now uses quickstart/card-program and quickstart/wallets-integration):

MISO card API (11 pages, not in nav, not wired to any referenced OpenAPI spec):

  • api-reference/miso/health-check
  • api-reference/miso/miso/check-username-availability
  • api-reference/miso/miso/complete-tuyo-oauth-flow
  • api-reference/miso/miso/create-a-new-card
  • api-reference/miso/miso/delete-a-card
  • api-reference/miso/miso/get-user-cards
  • api-reference/miso/miso/get-user-profile
  • api-reference/miso/miso/initiate-tuyo-oauth-flow
  • api-reference/miso/miso/register-a-new-user
  • api-reference/miso/miso/rename-a-card
  • api-reference/miso/miso/validate-referral-code

Signing API (5 pages):

  • api-reference/signing/introduction
  • api-reference/signing/get-confirmations
  • api-reference/signing/get-signing-status
  • api-reference/signing/request-unlock
  • api-reference/signing/submit-signing

Stash V1 liquidity API (2 pages):

  • api-reference/stash/liquidity/get-the-borrow-quote-for-a-liquidity-transaction
  • api-reference/stash/liquidity/get-signing-authorization-for-a-liquidity-transaction

Other:

  • architecture/stash-repayment

2. Unused OpenAPI specs

Present in the repo but not referenced by mint.json openapi (which only lists api-reference/sprinter/openapi.json and api-reference/solve/openapi.yaml):

  • api-reference/miso/openapi.json
  • api-reference/miso/openapi-v2.json
  • api-reference/sprinter/openapi-v2.json
  • api-reference/stash/openapi.json

Decide whether these back the orphaned API pages above (wire them up) or should be deleted.

3. stash-v1 slug inconsistency

The product is branded "Sprinter Liquidity" everywhere user-facing, but the directory/URL slug is still stash-v1/, so live URLs read docs.sprinter.tech/stash-v1/*:

  • index.mdx:17<Card title="Sprinter Liquidity" ... href="/stash-v1/overview">
  • index.mdx:39<Card title="Crosschain Solvers" ... href="/stash-v1/integration-guide">
  • mint.json nav — stash-v1/overview, stash-v1/contracts, stash-v1/integration-guide
  • stash-v1/overview.mdx:119 — internal link to /stash-v1/integration-guide

These also flow into llms.txt (entries titled "Sprinter Liquidity…" pointing at /stash-v1/*.md). Consider renaming stash-v1/sprinter-liquidity/ with redirects, or confirm the path is kept intentionally for backwards compatibility.

Not flagged as a problem (legitimate v1 usages, listed for completeness): the historical V1→V2 narrative in sprinter-credit/overview.mdx, real API paths GET /v1/route and /v1/chains/..., and third-party morpho-v1 / "Morpho V1" protocol names.

4. Downstream effect on llms.txt / llms-full.txt

llms.txt and llms-full.txt are generated from the nav, so they currently match main's navigation — they are not themselves stale. But because the orphaned pages in §1 remain live, anything fetching by URL or crawling the site directly (search engines, AI agents) still picks up the superseded content. Resolving §1 fixes this.


Acceptance criteria

  • Every live page at docs.sprinter.tech is reachable via the website navigation (no orphaned/ghost pages).
  • Superseded duplicate pages (kast-card*, metamask-integration, wallet-integration) are removed or redirected to their nav replacements.
  • Orphaned API reference pages (MISO, Signing, Stash V1) are either added to the nav (and wired to their OpenAPI specs) or removed.
  • Unused OpenAPI specs are wired up or deleted.
  • stash-v1 slug decision made (rename + redirect, or keep intentionally) and applied consistently.

Housekeeping (optional, separate)

The master branch (HEAD e721c83, 2026-04-02) is stale and structurally divergent from main (still uses docs/ subdir, stash-credit-v2/, stash-points, governance). Consider deleting it to avoid confusion, since deployment is from main.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type: DocumentationAdded to issues or PRs that relate to the project wiki, or documentation.

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions