Skip to content

fix: main red, llms.txt H1 wrongly capitalized by #855 brand fix #868

Description

@vivek7405

Problem

main is red. The brand-casing one-time fix in #855 capitalized the llms.txt index H1 in docs/lib/llms.server.ts from # webjs documentation to # WebJs documentation (lines ~347 and ~384, plus the JSDoc at ~338). But test/docs/llms.test.mjs:55 asserts /^# webjs documentation/ and docs/AGENTS.md:54 documents the H1 as the lowercase # webjs documentation. The one-time fix over-reached into a generated-file identifier that is pinned by a test and a doc contract.

The failing check was present on #855 (the "Unit + integration" job failed) and was bypassed by an --admin merge, so it landed on main.

Design / approach

Revert the llms.txt index H1 to the documented lowercase # webjs documentation (index and full-corpus), restoring the test + docs/AGENTS.md contract. The per-page blurbs in the llms output stay brand-cased (they are page descriptions, not the pinned H1, and no test asserts them). This is the minimal, contract-honoring fix. Capitalizing the H1 as a deliberate brand change would instead require updating the test and the AGENTS.md spec together, out of scope for a red-main hotfix.

Implementation notes (for the implementing agent)

  • Edit docs/lib/llms.server.ts: the two push('# WebJs documentation'...) calls (index around L347, full-corpus around L384) back to lowercase webjs, and the JSDoc comment around L338.
  • Verify: node --test test/docs/llms.test.mjs (the GET /llms.txt H1 test must pass; the corpus test at L106 checks no webjs build command, already lowercase, keep it).
  • Landmine: docs/lib/llms.server.ts is flagged binary by git (pre-existing non-ASCII doc content, not corruption). Edit with a UTF-8-safe tool.
  • Process landmine that caused this: do NOT --admin-merge past a FAILING check. --admin bypasses failing checks, not just the review gate. Re-verify gh pr checks is green immediately before any admin merge.

Acceptance criteria

  • llms.txt index and full-corpus H1 emit # webjs documentation again
  • node --test test/docs/llms.test.mjs passes
  • main CI green

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions