feat(v0.3): manifest.json, llms.txt, and cross-document overview#1
Open
b02thomas wants to merge 1 commit into
Open
feat(v0.3): manifest.json, llms.txt, and cross-document overview#1b02thomas wants to merge 1 commit into
b02thomas wants to merge 1 commit into
Conversation
…board Every build now emits four companion files alongside index.html so the output is usable both as a human-facing dashboard and as an agent-readable bundle: - overview.html — aggregates ## Open Questions / Decisions / Risks / Assumptions / Blockers / TODOs from every .md into one scannable view, with open/done checkbox markers for task-list items. Linked from the index sidebar whenever at least one interest section is detected. - manifest.json — machine-readable index: every doc with title, section, words, frontmatter tags, top-level headings, interest-section counts, and mtime. Read one file to know what the bundle contains. - llms.txt — llmstxt.org-style short index (title + first paragraph per doc, grouped by section) for LLM context injection. - llms-full.txt — full concatenated Markdown bundle for full-context LLM prompts. Also: - YAML-ish frontmatter parser (title, tags, section keys) shared between the builder, the manifest, and the overview. - --no-manifest / --no-llms / --no-llms-full / --no-overview opt-outs. - .gitignore covers the new generated demo artifacts. Zero new dependencies. Node stdlib only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Turns a doc bundle into something both humans AND agents can read.
Every build now emits four companion files alongside
index.html:overview.html— cross-document dashboard aggregating every## Open Questions,## Decisions,## Risks,## Assumptions,## Blockers, and## TODOssection from every.md. Task-list items- [ ]/- [x]render as open/done markers. Linked from the index sidebar whenever at least one interest section is detected.manifest.json— machine-readable index. One JSON file listing every doc with title, section, words, frontmatter tags, top-level headings, interest-section counts, and mtime. Read this file to know what's in the bundle without parsing any HTML.llms.txt— llmstxt.org-style short index (title + first paragraph per doc) for LLM context injection.llms-full.txt— full concatenated Markdown bundle for full-context LLM prompts.Also:
title,tags,section) shared between builder, manifest, and overview.--no-manifest/--no-llms/--no-llms-full/--no-overviewopt-outs..gitignorecovers the new generated demo artifacts.Zero new dependencies — Node stdlib only.
Test plan
npm run demosucceeds, generates all four companion files## Open Questions,## Open Decisions,## Risks,## Blockersproduces correctly bucketedoverview.html(10 items, 4 buckets verified)tags: [prd, step-9]round-trips intomanifest.jsonwith aggregated tag counts↗ Open decisions · questions · riskslink only when at least one interest section exists- [x]task-list items render as checked/struck,- [ ]as open checkbox markers--no-manifest/--no-llms/--no-overviewflags suppress their respective outputsFiles
lib/scan.mjs— frontmatter parser, heading extractor, interest-section detectorlib/manifest.mjs— manifest.json writerlib/llms.mjs— llms.txt / llms-full.txt writerslib/overview.mjs— overview.html rendererlib/build.mjs— integrates the four writers into the build pipelinelib/template.mjs— sidebar link + CSS for the overview entrybin/cli.mjs— new--no-*flags + help textREADME.md— companion outputs section, frontmatter docs, interest-section labelspackage.json— v0.3.0