Repository navigation
feat(llms): list all docs pages in llms.txt and add a coverage check - #239
Open
thzgajendra wants to merge 2 commits into
Open
thzgajendra wants to merge 2 commits into
thzgajendra wants to merge 2 commits into
Conversation
llms.txt linked 66 of 105 docs pages and omitted the MCP and LLM guides and all production guides. List every page, add an AI and agents section and a production guides section, and add utils/check-llms-coverage.mjs to fail when a docs page is missing.
Keep this change to llms.txt content only.
Umang01-hash
approved these changes
Oct 12, 2026
Umang01-hash
left a comment
Member
There was a problem hiding this comment.
Reviewed at head 9fa1c0f. Verified all 40 newly-added doc URLs resolve (200) — no dead links, which is the key safety property for llms.txt. No PR-introduced duplicates (the two AGENTS.md occurrences are a pre-existing prose mention + list entry, not added here).
Nit: the title says "add a coverage check", but the PR is public/llms.txt only — there's no check. Since the docs content isn't in this repo, completeness ("list all docs pages") can't be enforced without that guard, so either add the check or adjust the title. Content LGTM.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
public/llms.txt, which previously linked 66 of 105 pages.llms.txtis the file AI tools read first. It omitted the MCP and LLM guides and all 18 production guides, so GoFr's AI features were invisible in its own AI index.What changed in
llms.txt:/docs/guides/*pages, each with a one-line description.gofrCLI subcommand pages, the/comparisonand/migrateindexes, the/docshome, andllms-full.txt.Not included:
docs/quick-start/cli/page.mdin gofr is an empty file, so it is not listed. It looks like a stray file and may be worth a separate look.Breaking Changes (if applicable):
Additional Information:
page.mdroute ingofr-dev/gofr@developmentdocs/against the links inllms.txt: before, 39 of 105 pages were missing; after, all 105 are listed.llms.txtreturn HTTP 200 on https://gofr.dev (checked with curl).injecting-databases-drivers,datasources/migrations/elasticsearch, fourgofrclipages,/comparison,/migrate,/docs) and these are included too.