Repository navigation
Docs: answer-first READMEs, FAQ, docs index, llms.txt, trimmed npm page; factual fixes - #69
Open
Karanvir1729 wants to merge 6 commits into
Open
Karanvir1729 wants to merge 6 commits into
Karanvir1729 wants to merge 6 commits into
Conversation
…pm page; factual fixes Implements a six-surface audit (README, npm pages, docs, accuracy, AEO). Every number checked against RESULTS.md, compat/RESULTS.md, the model card or the code; FIR next to recall. The package README is under 60,000 characters (npm truncates at 65,536), with reference material moved to docs/runtime/ INSTALL.md, DASHBOARD.md and SINKS.md. New: FAQ.md, docs/runtime/README.md (index and glossary), llms.txt, CITATION.cff, issue template config. No src/, test/, AGENTS.md, CONTRACT.md or NOTICE change. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…mcp) into docs/seo-aeo-npm Conflicts resolved by hand: both package.json files take main's version (0.3.0-beta.1) with this branch's descriptions; the trimmed READMEs keep their structure and gain main's "Your coding agent" section, the packages/mcp row and the 0.3.0-beta.1 script-tag pin; THREAT-MODEL.md keeps T10 to T12 and adds the bridge as T13 (residual 14); RESULTS.md keeps sections 16 and 17 and adds the coding-agent measurement as section 18, with a row in the summary table. References in CHANGELOG.md, AGENT.md and the root README follow the new numbers; docs/runtime/README.md and llms.txt list AGENT.md. tsc clean, tsup builds, vitest 1,101 passed (14 model-parity skips), review-perf 4 of 4. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
8 tasks done
# Conflicts: # README.md # packages/playwright/README.md # packages/playwright/package.json
# Conflicts: # docs/runtime/RESULTS.md # packages/runtime/README.md
…talled, analytics visits) into docs/seo-aeo-npm Eleven files conflicted; each keeps this branch's answer-first structure and carries main's newer facts: the runtime package.json takes 0.3.0-beta.4 with this branch's description; both READMEs state today's dist-tags, pin @0.3.0-beta.4 in script tags, and gain the scan/audit command, summary().requests, the three new measured checks, the analytics navigation paths and visit flag, and @genclass/mcp 0.2.0; the root README has its "**Status:" line back, which packages/sv/test/edit.test.ts reads (the check that failed on the pull request); TELEMETRY.md, PRIVACY.md, ANALYTICS.md and OPTIONS-SPEC.md take main's new sections on visits, funnels, devices and the new options; INTERCEPTION.md's machine-checked inventory equals main's. RESULTS.md's two sections appended on main after this branch's §16 and §17 are now §23 and §24, and AGENTS.md, VISUAL.md, bench/visual/README.md, the runtime README and CHANGELOG follow. tsc clean, tsup builds, runtime vitest 1,212 passed (14 model-parity skips); @genclass/sv unit 24 passed; @genclass/mcp 132 passed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…raise advisory) into docs/seo-aeo-npm Three files conflicted. THREAT-MODEL.md T8 takes main's text: raising the mode from a link needs a development host (src/devhost.ts) and `debug: true` is console logging only. INTERCEPTION.md takes main's sessionStorage row (the sampling bucket is reused only under the same `sample`) and keeps this branch's localStorage row. The runtime README keeps its trimmed script-tag paragraph and adds main's `data-devtools="local"` host list. Five passages this branch wrote still described the old behaviour (local or private hosts and `debug: true` raising the mode): the threat model's residual 8 and recommended setup, the docs index's glossary, the runtime README's URL-override paragraph, OPTIONS-SPEC's formula comment and batch note, and API.md's effectiveMode sentence now state the current rule. tsc clean, tsup builds, runtime vitest passed (14 model-parity skips); @genclass/mcp 142 passed; @genclass/sv unit 24 passed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This branch has not been deployed
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.
What
Implements the docs, scrapability, SEO/AEO and npm landing page audit. Answer-first READMEs with one canonical definition; FAQ.md; docs/runtime/README.md index and glossary; llms.txt, CITATION.cff; the npm README trimmed under 60,000 characters (npm truncates at 65,536) with reference material moved to docs/runtime/INSTALL.md, DASHBOARD.md, SINKS.md; package.json description and keywords; about 30 factual corrections (e.g. late-revert window 800 ms, the compat matrix commit, gate guidance for the 0.2.0 gain gate, FIR wording).
Notes for the reviewer
0.3.0; it contradicts SINKS.md and needs correcting).🤖 Generated with Claude Code