docs(auryn): add dedicated Auryn documentation section

SW
7h ago
+524-1

Closes #598

What

Adds a dedicated Auryn documentation section to docs.falkordb.com, based on the Auryn product docs design.

Auryn is added as a new top-level product in docs.json with inline content under auryn/, so it appears in the product switcher alongside FalkorDB, Cloud, Enterprise, and GraphRAG SDK, and is served at /auryn (mirroring how /cloud and /graphrag present their sections).

Pages (18)

GroupPages
Get StartedOverview, Quickstart, Connect your agent
Using AurynAsking your agent, Agent tools, Keeping it fresh, Many repositories, Semantic search, Change impact in CI, The viewer
ReferenceLanguages & sources, CLI, Graph model, Files & configuration, Sharing a graph, Hooks
ProjectPrivacy & security, Contributing

Also

  • Updated the AI-assistant product context in docs.json (four → five products).
  • Added Auryn, Aider, Antigravity, and ADRs to .wordlist.txt for spellcheck.

Notes / adaptations

  • Page titles and descriptions use SEO-style framing to match the rest of the site; sidebar titles match the reference design.
  • British spellings normalized to US English for consistency and the spellcheck CI.
  • References to Auryn repo docs (docs/cli.md, ADRs, etc.) link to the Auryn GitHub repo rather than guessed deep links.
  • Added house-style FAQ accordions, cross-link callouts, and a "Why Auryn" overview section, consistent with existing FalkorDB pages.

Validation

  • node scripts/check_mdx.mjs → 215 files, 0 syntax errors.
  • docs.json is valid JSON; every registered page exists and every internal link resolves.
  • Local emulation of the pyspelling (.spellcheck.yml) check passes.
  • Rendered locally with mint dev and verified the section loads at /auryn.

🤖 Generated with Claude Code


Summary by cubic

Adds a dedicated Auryn documentation section to docs.falkordb.com with 18 pages covering the product from quickstart through MCP agent setup, graph model, CLI, CI change-impact analysis, and security. Auryn now appears as a top-level product at /auryn, mirroring how Cloud and GraphRAG are presented.

  • Registers Auryn's page groups (Get Started, Using Auryn, Reference, Project) in docs.json.
  • Updates the site's AI-assistant context from four to five products.
  • Extends the spellcheck wordlist with Auryn, Aider, Antigravity, ADRs, and CUDA.
  • Documents CUDA support in the Languages & sources page and bumps the supported language count to sixteen.
  • Documents the batteries-included pip install falkordb-auryn (every language, embedded database, and hooks) with lean single-language installs and opt-in live-database drivers as extras.
  • Links the overview page to the open-source Auryn repository on GitHub.

All internal links resolve and the MDX passes validation.

Summary by CodeRabbit

  • Documentation
    • Added an Auryn documentation section covering quickstart setup, coding-agent integration, MCP tools, querying code, CLI commands, configuration, and privacy.
    • Added guides for change-impact analysis, multi-repository workflows, graph sharing, supported languages, refreshes, hooks, and contributing.
    • Documented graph structure, semantic search, and the local viewer.
    • Added Auryn to the documentation navigation and expanded the word list.