Skip to content

docs: tune Mintlify search metadata#16

Open
sorinc03 wants to merge 1 commit into
wraith-protocol:mainfrom
sorinc03:codex/mintlify-search-tuning-11
Open

docs: tune Mintlify search metadata#16
sorinc03 wants to merge 1 commit into
wraith-protocol:mainfrom
sorinc03:codex/mintlify-search-tuning-11

Conversation

@sorinc03
Copy link
Copy Markdown

Fixes #11.

Summary

  • adds supported Mintlify search ranking boosts in docs.json so onboarding and guides rank above reference pages
  • adds page-level keywords across every MDX page, including Stellar/Soroban/friendbot/testnet synonym coverage
  • enables telemetry explicitly and adds a search review cadence plus SEARCH_TESTS.md expected-query checklist
  • fixes broken relative SDK links found while validating

Notes

Mintlify current public schema supports search.prompt, navigation/frontmatter boost, and page keywords, but not a schema-level docs.json synonym map. I implemented synonym coverage through indexed page keywords, which is the supported internal-search path.

Validation

  • npx --yes prettier@3.5.3 --check docs.json '*.mdx' 'architecture/*.mdx' 'api-reference/*.mdx' 'contracts/*.mdx' 'guides/*.mdx' 'sdk/*.mdx' 'sdk/chains/*.mdx' CONTRIBUTING.md SEARCH_TESTS.md
  • npx --yes mintlify@latest validate
  • npx --yes mintlify@latest broken-links

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.

Mintlify search index tuning + analytics

1 participant