Skip to content

Mintlify search index tuning + analytics #11

@truthixify

Description

@truthixify

Labels: Stellar Wave, config, docs, drips, help-wanted
Tier: S (½–1 day)
Type: config

Context

Mintlify ships with built-in search but we've never configured the index or watched what users search for. We probably have the default settings, which means nothing is weighted, no synonyms, no analytics on missed queries.

Scope

  1. Configure search in docs.json:
    • Add synonym groups: stealthunlinkable, meta-addressmetaaddressmeta address, SorobanStellar smart contract, friendbottestnet faucet, etc.
    • Weight pages: getting-started > guides > reference (search should prefer onboarding paths).
    • Add page-level keywords to the frontmatter of every MDX (especially Stellar pages).
  2. Enable search analytics (Mintlify supports this).
  3. Document a quarterly review cadence in docs/CONTRIBUTING.md: "Once a quarter, look at the top 20 zero-result queries and either add a page or a synonym."
  4. Add a manual test list at docs/SEARCH_TESTS.md: 15 queries we expect to return specific top results. (E.g., "send stellar payment" → stellar-quickstart.mdx as Stellar end-to-end integration tutorial #1.)

Acceptance criteria

  • docs.json updated with synonyms, weights, keywords.
  • Search analytics enabled.
  • SEARCH_TESTS.md committed.
  • Manually verify each test query produces the expected result.

Why this matters

A docs site that doesn't surface "the right thing first" trains users to bounce to Google → results from random forum threads → blame Wraith for being confusing. We fix this at the source.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave programconfigConfiguration / settingsdocsDocumentationdripsFunded via Drips Networkhelp wantedExtra attention is needed

    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