Tighten methodology#25
Conversation
Refresh the methodology page so the comparison survives 2026 reality: Mintlify ships a headless Astro mode (still SaaS-bound), Fumadocs supports llms.txt and content negotiation via route handlers, and Starlight has the starlight-llms-txt community plugin plus Pagefind. The "use leadtype when..." paragraph swaps "own the docs UI" for the sharper wedge — owning the generated artifacts (framework-agnostic markdown, search, llms.txt, topic-scoped context bundles, and npm-bundled AGENTS.md docs).
📝 WalkthroughWalkthroughDocumentation updates expand the framework comparison, enumerate Leadtype-produced artifacts (markdown, navigation, search, llms.txt, context bundles, AGENTS.md), and list additional integration outputs for pairing Leadtype with website frameworks. ChangesMethodology Documentation Clarification
🎯 1 (Trivial) | ⏱️ ~3 minutes
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/methodology.mdx`:
- Line 20: The three consecutive sentences starting with "Use" in the paragraph
("Use a website framework...", "Use a hosted platform...", "Use leadtype...")
are flagged for repetitive sentence beginnings; rewrite them to vary openings
while preserving meaning and parallel comparison—e.g., start the first with
"Choose a website framework when...", the second with "Consider a hosted
platform if you want...", and the third with "Opt for leadtype when you need to
own the generated docs artifacts"—and ensure the list still mentions
framework-agnostic markdown, navigation, search, `llms.txt`, topic-scoped
context bundles, and optional `AGENTS.md` package bundles.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: a6544659-8540-4d54-9d52-78370d963284
⛔ Files ignored due to path filters (3)
apps/example/src/generated/agent-readability.jsonis excluded by!**/generated/**apps/example/src/generated/docs-search-content.jsonis excluded by!**/generated/**apps/example/src/generated/docs-search-index.jsonis excluded by!**/generated/**
📒 Files selected for processing (1)
docs/methodology.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
🪛 LanguageTool
docs/methodology.mdx
[style] ~20-~20: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...res and accept that service dependency. Use leadtype when you want to **own the gen...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔍 Remote MCP Context7
Summary of Verified Information
Based on my research of the framework documentation, here are the relevant findings that support your PR review:
Fumadocs Verification Fumadocs supports multiple React frameworks as claimed in the PR:
- Next.js: API routes with path rewriting for
.mdmarkdown content - TanStack Start: File-based routing with server handlers for
.mdroutes - React Router: Middleware-based path rewriting with server loaders for LLM content
The documentation shows explicit route handler patterns for content negotiation, confirming the PR's description of Fumadocs using "manual route-handler llms.txt and content negotiation."
Starlight Verification Starlight is confirmed as Astro-only and supports Pagefind for static client-side search. The documentation shows integration with Algolia DocSearch via the @astrojs/starlight-docsearch plugin, and configuration of built-in Pagefind search via pagefind: true setting in the Starlight config. However, the specific starlight-llms-txt community plugin mentioned in the PR was not found in the primary documentation—this may be a community/third-party extension that would need verification separately.
Mintlify Verification Mintlify documentation confirms:
- Headless/Custom frontend mode using
@mintlify/astrointegration is available, allowing developers to use their own Astro projects - SaaS runtime dependency: Search (
/v1/search/{domain}API) and assistant features (/api/assistant/create-assistant-message-v2) call Mintlify APIs (api.mintlify.com), confirming the PR's note about "SaaS runtime dependency (search and assistant still call Mintlify APIs)" - The headless mode provides "full control over the design, layout, and behavior" while leveraging Mintlify for content management
Key Observation
The PR's characterization of these frameworks appears well-supported by official documentation, with the caveat that the specific starlight-llms-txt community plugin should be verified to ensure it's the current/standard solution for Starlight's llms.txt support.
🔇 Additional comments (2)
docs/methodology.mdx (2)
40-40: LGTM! Clear articulation of Leadtype's unique value.The pairing guidance effectively highlights Leadtype's framework-agnostic outputs (
llms-full/<group>.txt, Agent Readability files, npm-bundledAGENTS.md) that complement website frameworks without duplication. This positioning aligns well with the PR's goal to emphasize portable artifact ownership.
16-16: ⚡ Quick winNo changes needed. The
starlight-llms-txtplugin exists and is current (v0.8.0, released 2026-03-12). It is the standard community solution for Starlight'sllms.txtsupport. Documentation: https://github.com/delucis/starlight-llms-txt
…-mintlify # Conflicts: # apps/example/src/generated/agent-readability.json # apps/example/src/generated/docs-search-content.json # apps/example/src/generated/docs-search-index.json
The three consecutive sentences in the "when to pick which tool" paragraph all started with "Use", which read repetitive. Swap to "Choose / Consider / Opt for" to vary the openings while keeping the parallel comparison and the full artifact list (framework-agnostic markdown, navigation, search, llms.txt, topic-scoped context bundles, AGENTS.md package bundles).
Summary
docs/methodology.mdxso the comparison survives 2026 reality:llms.txt+ content negotiation.llms.txtvia thestarlight-llms-txtcommunity plugin and Pagefind for static client-side search.llms.txt, topic-scoped context bundles, and npm-bundledAGENTS.mddocs.AGENTS.md+ topicdocs/*.md, topic-scopedllms-full/<group>.txtper group, Agent Readability files, no route-handler / community-plugin glue.agent-readability.jsonand search index/content artifacts that update from the methodology edit.Test plan
bun run --filter example pipeline:build— 16 docs converted, llms files + search index generated.apps/example/public/docs/methodology.mdto confirm the rewritten table and paragraphs render correctly.