Skip to content

Add API reference details and history landing pages#390

Draft
danielporterda wants to merge 2 commits into
mainfrom
issue-365-details-history
Draft

Add API reference details and history landing pages#390
danielporterda wants to merge 2 commits into
mainfrom
issue-365-details-history

Conversation

@danielporterda
Copy link
Copy Markdown
Contributor

@danielporterda danielporterda commented May 12, 2026

Summary

  • standardizes API Reference landing cards so they land on each API area's Details and history entry
  • removes the hand-authored card-wrapper style from the new top-level details pages
  • makes the new top-level Ledger API, dApp API, Splice APIs, and Admin API details pages table-based pointers into the x2mdx-derived details/history output
  • points TypeScript directly at the generated TypeDoc details/history page and updates the TypeScript generator default title so regeneration preserves that label
  • keeps Daml Standard Library and Wallet Gateway on their existing x2mdx-derived details/history pages

This addresses the missing details/history page slice of #365. I did not mark the full issue closed because #365 covers several topics.

Screenshots

API Reference landing page

Shows the API Reference cards still landing on Details and history entries, with TypeScript now targeting the generated TypeDoc page directly.

Ledger API table-based details and history page

Shows the corrected top-level Ledger API page using table-style details/history links instead of a card grid.

TypeScript generated details and history page

Shows the generated TypeDoc details/history page with its derived table of contents and version change summary.

Validation

  • direnv exec . python3 -m pytest tests/test_api_reference_navigation.py tests/test_wallet_kernel_nav.py tests/test_ledger_bindings_nav.py
  • direnv exec . npx mintlify validate from docs-main
  • direnv exec . npx mintlify broken-links from docs-main
  • direnv exec . git diff --check

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 12, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cantonfoundation 🟢 Ready View Preview May 12, 2026, 9:07 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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