Skip to content

Commit aaa3854

Browse files
committed
docs: update README and all docs pages to v1.5.0 state
- README: test count 177 → 274, add vscode-extension/ and inject-search.py to structure - All 6 docs pages: footer version v1.1.0 → v1.5.0 - quick-start.html: terminal version, --diff flags, roadmap card (12→16 versions, 177→274 tests) - strategies.html: hero badge updated to current as of v1.5 - roadmap.html: meta, hero (v1.1→v1.5, 177→274 tests, 12→16 versions), token bar (add v1.3 diff-mode row), timeline (add v1.2/v1.3/v1.4/v1.5 entries), final stats headline v1.5.0
1 parent f11c9a5 commit aaa3854

7 files changed

Lines changed: 129 additions & 22 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ node test/run.js --update # regenerate expected outputs
317317
```bash
318318
# Gate 1: all tests pass
319319
node test/run.js
320-
# Expected: 177/177 PASS (21 extractor + 156 integration)
320+
# Expected: 274/274 PASS (21 extractor + 253 integration)
321321

322322
# Gate 2: no external imports
323323
grep "require(" gen-context.js | grep -v "^.*//.*require"
@@ -342,9 +342,10 @@ src/format/cache.js ← Anthropic prompt-cache JSON formatter (v0.8)
342342
src/routing/ ← model routing hints (v0.7)
343343
src/tracking/logger.js ← NDJSON usage log (v0.9)
344344
src/health/scorer.js ← composite health score (v1.0)
345-
src/mcp/ ← MCP stdio server (v0.3)
345+
src/mcp/ ← MCP stdio server (v0.3); 7 tools
346346
src/security/ ← secret scanner (v0.2)
347347
src/config/ ← config loader + defaults
348+
vscode-extension/ ← VS Code extension — status bar, commands, stale alert (v1.5)
348349
test/fixtures/ ← one fixture per language
349350
test/expected/ ← expected extractor output
350351
test/run.js ← zero-dep test runner
@@ -354,6 +355,7 @@ docs/REPOMIX_CACHE.md ← prompt cache strategy guide (v0.8)
354355
docs/MODEL_ROUTING.md ← model routing guide (v0.7)
355356
examples/self-healing-github-action.yml ← auto-regeneration CI workflow (v1.0)
356357
scripts/ci-update.sh ← CI helper for pipelines (v1.0)
358+
scripts/inject-search.py ← one-time migration: adds search to docs HTML (v1.5)
357359
.contextignore.example ← exclusion template
358360
gen-context.config.json.example ← annotated config reference
359361
```

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ <h2>Built for the community</h2>
432432
<!-- FOOTER -->
433433
<footer>
434434
<div class="footer-inner">
435-
<span class="footer-logo">context-forge v1.1.0</span>
435+
<span class="footer-logo">context-forge v1.5.0</span>
436436
<div class="footer-links">
437437
<a href="quick-start.html">Quick start</a>
438438
<a href="strategies.html">Strategies</a>

docs/languages.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,7 @@ <h2>Contributing is simple</h2>
614614

615615
<footer>
616616
<div class="footer-inner">
617-
<span class="footer-logo">context-forge v1.1.0</span>
617+
<span class="footer-logo">context-forge v1.5.0</span>
618618
<div class="footer-links">
619619
<a href="quick-start.html">Quick start</a>
620620
<a href="strategies.html">Strategies</a>

docs/quick-start.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ <h2>Command reference</h2>
437437
<span class="term-title">node gen-context.js --help</span>
438438
</div>
439439
<div class="term-body">
440-
<div><span class="tp">ContextForge v1.0.0</span></div>
440+
<div><span class="tp">ContextForge v1.5.0</span></div>
441441
<div>&nbsp;</div>
442442
<div><span class="tc">Usage:</span> <span class="tw">node gen-context.js [flag]</span></div>
443443
<div>&nbsp;</div>
@@ -447,8 +447,10 @@ <h2>Command reference</h2>
447447
<div><span class="ts"> --mcp </span><span class="tc">Start MCP server on stdio</span></div>
448448
<div><span class="ts"> --report </span><span class="tc">Print token reduction stats to stdout</span></div>
449449
<div><span class="ts"> --report --json </span><span class="tc">Token report as JSON (for CI pipelines)</span></div>
450-
<div><span class="ts"> --health </span><span class="tc">Run all 21 extractor health checks</span></div>
451-
<div><span class="ts"> --suggest-tool </span><span class="tc">Recommend MCP tool for current task context</span></div>
450+
<div><span class="ts"> --diff </span><span class="tc">Generate context for git-changed files only</span></div>
451+
<div><span class="ts"> --diff --staged </span><span class="tc">Generate context for staged files only</span></div>
452+
<div><span class="ts"> --health </span><span class="tc">Composite 0-100 health score (grade A-D)</span></div>
453+
<div><span class="ts"> --suggest-tool </span><span class="tc">Recommend fast/balanced/powerful model tier</span></div>
452454
<div><span class="ts"> --track </span><span class="tc">Log run metrics to .context-forge/runs.jsonl</span></div>
453455
<div><span class="ts"> --init </span><span class="tc">Write gen-context.config.json.example</span></div>
454456
<div><span class="ts"> --version </span><span class="tc">Print version string</span></div>
@@ -479,16 +481,16 @@ <h2>Explore further</h2>
479481
<div class="next-card-desc">Stack both tools for the two-layer caching strategy. ContextForge for daily; Repomix for deep sessions.</div>
480482
</a>
481483
<a class="next-card" href="roadmap.html">
482-
<div class="next-card-ey">v0.1 → v1.1</div>
484+
<div class="next-card-ey">v0.1 → v1.5</div>
483485
<div class="next-card-title">Full roadmap</div>
484-
<div class="next-card-desc">All 12 versions shipped. 97% token reduction. 177 tests. MIT license.</div>
486+
<div class="next-card-desc">All 16 versions shipped. 97% token reduction. 274 tests. MIT license.</div>
485487
</a>
486488
</div>
487489
</section>
488490

489491
<footer>
490492
<div class="footer-inner">
491-
<span class="footer-logo">context-forge v1.1.0</span>
493+
<span class="footer-logo">context-forge v1.5.0</span>
492494
<div class="footer-links">
493495
<a href="strategies.html">Strategies</a>
494496
<a href="languages.html">Languages</a>

docs/repomix.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ <h2>Both tools, five minutes</h2>
513513

514514
<footer>
515515
<div class="footer-inner">
516-
<span class="footer-logo">context-forge v1.1.0</span>
516+
<span class="footer-logo">context-forge v1.5.0</span>
517517
<div class="footer-links">
518518
<a href="quick-start.html">Quick start</a>
519519
<a href="strategies.html">Strategies</a>

docs/roadmap.html

Lines changed: 112 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1.0">
66
<title>Roadmap — ContextForge</title>
7-
<meta name="description" content="ContextForge shipped v0.1 through v1.112 versions, 97% token reduction, 177 tests. Full visual timeline from baseline to complete system.">
8-
<meta property="og:title" content="ContextForge Roadmap — v0.1 to v1.1 complete">
9-
<meta property="og:description" content="11 versions shipped. 97% token reduction. 177 tests. MIT license. See how ContextForge was built from first extractor to full enterprise system.">
7+
<meta name="description" content="ContextForge shipped v0.1 through v1.516 versions, 97% token reduction, 274 tests. Full visual timeline from baseline to complete system.">
8+
<meta property="og:title" content="ContextForge Roadmap — v0.1 to v1.5 complete">
9+
<meta property="og:description" content="15 versions shipped. 97% token reduction. 274 tests. MIT license. See how ContextForge was built from first extractor to full enterprise system.">
1010
<meta property="og:url" content="https://manojmallick.github.io/context-forge/roadmap.html">
1111
<meta name="twitter:card" content="summary_large_image">
1212
<link rel="canonical" href="https://manojmallick.github.io/context-forge/roadmap.html">
@@ -141,11 +141,11 @@
141141
<div class="page-hero">
142142
<div class="hero-inner">
143143
<div class="hero-badge"><span class="dot"></span>All versions complete</div>
144-
<h1>v0.0 → v1.1</h1>
145-
<p class="hero-sub">Twelve versions. Every one shipped. MIT open source from day one.</p>
144+
<h1>v0.0 → v1.5</h1>
145+
<p class="hero-sub">Sixteen versions. Every one shipped. MIT open source from day one.</p>
146146
<div class="hero-stats">
147147
<div class="hstat"><span class="hstat-val p">97%</span><span class="hstat-lbl">Token reduction</span></div>
148-
<div class="hstat"><span class="hstat-val g">177</span><span class="hstat-lbl">Tests passing</span></div>
148+
<div class="hstat"><span class="hstat-val g">274</span><span class="hstat-lbl">Tests passing</span></div>
149149
<div class="hstat"><span class="hstat-val g">21</span><span class="hstat-lbl">Languages</span></div>
150150
<div class="hstat"><span class="hstat-val g">0</span><span class="hstat-lbl">npm deps</span></div>
151151
</div>
@@ -202,6 +202,11 @@ <h2>Reduction by version</h2>
202202
<div class="tp-bar-bg"><div class="tp-bar" style="width:1%;background:var(--p)"></div></div>
203203
<div class="tp-val" style="color:var(--pd)">~200 always-on</div>
204204
</div>
205+
<div class="tp-row">
206+
<div class="tp-ver">v1.3</div>
207+
<div class="tp-bar-bg"><div class="tp-bar" style="width:0.5%;background:var(--p)"></div></div>
208+
<div class="tp-val" style="color:var(--pd)">50 diff-mode</div>
209+
</div>
205210
</div>
206211
</section>
207212

@@ -497,22 +502,120 @@ <h2>Every version, every feature</h2>
497502
</div>
498503
</div>
499504

505+
<!-- v1.2 -->
506+
<div class="tl-item">
507+
<div class="tl-rail">
508+
<div class="tl-dot done" style="background:rgba(124,106,247,.2);border-color:var(--p);color:var(--pd);font-size:10px">v1.2</div>
509+
<div class="tl-line"></div>
510+
</div>
511+
<div class="tl-content">
512+
<div class="tl-header">
513+
<span class="tl-version" style="background:linear-gradient(135deg,var(--t1),var(--pd));-webkit-background-clip:text;-webkit-text-fill-color:transparent">v1.2</span>
514+
<span class="tl-name">npm alias + test hardening</span>
515+
<span class="tl-badge done">✓ Complete — tagged v1.2.0</span>
516+
</div>
517+
<div class="tl-desc">Added <code>context-forge</code> npm binary alias alongside <code>gen-context</code> so <code>npx context-forge</code> works from any machine without cloning the repo. Improved <code>--init</code> to scaffold both <code>gen-context.config.json</code> and <code>.contextignore</code> in one step. Added 9 integration tests covering per-module and hot-cold strategy edge cases.</div>
518+
<div class="tl-tags">
519+
<span class="tl-tag">npx context-forge</span>
520+
<span class="tl-tag">--init .contextignore</span>
521+
<span class="tl-tag">strategy tests</span>
522+
<span class="tl-tag">9 new tests</span>
523+
<span class="tl-tag">MIT v1.2.0</span>
524+
</div>
525+
<div class="tl-impact">npm discoverability — works without cloning the repo</div>
526+
</div>
527+
</div>
528+
529+
<!-- v1.3 -->
530+
<div class="tl-item">
531+
<div class="tl-rail">
532+
<div class="tl-dot done" style="background:rgba(124,106,247,.2);border-color:var(--p);color:var(--pd);font-size:10px">v1.3</div>
533+
<div class="tl-line"></div>
534+
</div>
535+
<div class="tl-content">
536+
<div class="tl-header">
537+
<span class="tl-version" style="background:linear-gradient(135deg,var(--t1),var(--pd));-webkit-background-clip:text;-webkit-text-fill-color:transparent">v1.3</span>
538+
<span class="tl-name">--diff flag + watch debounce</span>
539+
<span class="tl-badge done">✓ Complete — tagged v1.3.0</span>
540+
</div>
541+
<div class="tl-desc">The <code>--diff</code> flag generates context only for files changed in the current git working tree — ideal for PR reviews and CI. <code>--diff --staged</code> restricts to staged files only, making it a perfect pre-commit check. Both modes auto-fall-back to full generate when outside a git repository or when no files have changed. Watch mode debounce is now configurable via <code>watchDebounce</code> in config.</div>
542+
<div class="tl-tags">
543+
<span class="tl-tag">--diff</span>
544+
<span class="tl-tag">--diff --staged</span>
545+
<span class="tl-tag">watchDebounce config</span>
546+
<span class="tl-tag">6 new tests</span>
547+
<span class="tl-tag">MIT v1.3.0</span>
548+
</div>
549+
<div class="tl-impact">Active PR work: ~50–200 tokens instead of ~4,000 — 95%+ reduction for diffs</div>
550+
</div>
551+
</div>
552+
553+
<!-- v1.4 -->
554+
<div class="tl-item">
555+
<div class="tl-rail">
556+
<div class="tl-dot done" style="background:rgba(124,106,247,.2);border-color:var(--p);color:var(--pd);font-size:10px">v1.4</div>
557+
<div class="tl-line"></div>
558+
</div>
559+
<div class="tl-content">
560+
<div class="tl-header">
561+
<span class="tl-version" style="background:linear-gradient(135deg,var(--t1),var(--pd));-webkit-background-clip:text;-webkit-text-fill-color:transparent">v1.4</span>
562+
<span class="tl-name">MCP tools + strategy health</span>
563+
<span class="tl-badge done">✓ Complete — tagged v1.4.0</span>
564+
</div>
565+
<div class="tl-desc">Two new MCP tools: <strong>explain_file</strong> returns signatures, resolved imports, and reverse callers for any file in a single call — agents get full file context without guessing paths. <strong>list_modules</strong> returns a token-count table of all top-level module directories so agents know where to look before calling <code>read_context</code>. Strategy-aware health scorer no longer penalises hot-cold or per-module runs for low reduction — intentionally small outputs score correctly. MCP server now exposes 7 tools total.</div>
566+
<div class="tl-tags">
567+
<span class="tl-tag">explain_file</span>
568+
<span class="tl-tag">list_modules</span>
569+
<span class="tl-tag">7 MCP tools</span>
570+
<span class="tl-tag">strategy health</span>
571+
<span class="tl-tag">25 new tests</span>
572+
<span class="tl-tag">MIT v1.4.0</span>
573+
</div>
574+
<div class="tl-impact">Precision context — agents ask for exactly the file context they need</div>
575+
</div>
576+
</div>
577+
578+
<!-- v1.5 -->
579+
<div class="tl-item">
580+
<div class="tl-rail">
581+
<div class="tl-dot done" style="background:rgba(124,106,247,.2);border-color:var(--p);color:var(--pd);font-size:10px">v1.5</div>
582+
</div>
583+
<div class="tl-content">
584+
<div class="tl-header">
585+
<span class="tl-version" style="background:linear-gradient(135deg,var(--t1),var(--pd));-webkit-background-clip:text;-webkit-text-fill-color:transparent">v1.5</span>
586+
<span class="tl-name">VS Code extension + npm publish</span>
587+
<span class="tl-badge done">✓ Complete — tagged v1.5.0</span>
588+
</div>
589+
<div class="tl-desc">A zero-dependency VS Code extension shows a status bar item displaying the health grade and time since last regeneration (refreshes every 60 s). It warns when context is stale (&gt;24 h), adds <strong>Regenerate Context</strong> and <strong>Open Context File</strong> commands, and supports a configurable script path. All six HTML documentation pages gained client-side keyword search (press <kbd>/</kbd> to open). A proper <code>.npmignore</code> prepares the package for npm publish — <code>npx context-forge</code> resolves to the runtime-only artifact.</div>
590+
<div class="tl-tags">
591+
<span class="tl-tag">VS Code extension</span>
592+
<span class="tl-tag">status bar</span>
593+
<span class="tl-tag">stale notification</span>
594+
<span class="tl-tag">docs search</span>
595+
<span class="tl-tag">.npmignore</span>
596+
<span class="tl-tag">58 new tests</span>
597+
<span class="tl-tag">MIT v1.5.0</span>
598+
</div>
599+
<div class="tl-impact">10× adoption surface — VS Code extension + npm discoverability</div>
600+
</div>
601+
</div>
602+
500603
</div>
501604
</section>
502605

503606
<hr class="divider">
504607

505608
<section class="section">
506609
<p class="section-ey">Final numbers</p>
507-
<h2>v1.1.0 at a glance</h2>
610+
<h2>v1.5.0 at a glance</h2>
508611

509612
<div class="final-grid">
510613
<div class="final-stat">
511614
<span class="final-stat-val p">97%</span>
512615
<div class="final-stat-lbl">Token reduction</div>
513616
</div>
514617
<div class="final-stat">
515-
<span class="final-stat-val g">177</span>
618+
<span class="final-stat-val g">274</span>
516619
<div class="final-stat-lbl">Tests passing</div>
517620
</div>
518621
<div class="final-stat">
@@ -533,7 +636,7 @@ <h2>v1.1.0 at a glance</h2>
533636

534637
<footer>
535638
<div class="footer-inner">
536-
<span class="footer-logo">context-forge v1.1.0</span>
639+
<span class="footer-logo">context-forge v1.5.0</span>
537640
<div class="footer-links">
538641
<a href="quick-start.html">Quick start</a>
539642
<a href="strategies.html">Strategies</a>

docs/strategies.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125

126126
<div class="page-hero">
127127
<div class="hero-inner">
128-
<div class="hero-badge">v1.1 strategy guide</div>
128+
<div class="hero-badge">strategy guide — current as of v1.5</div>
129129
<h1>Choose the right context strategy</h1>
130130
<p class="hero-sub">ContextForge supports three modes: full, per-module, and hot-cold. This page shows exactly when to use each one, what token cost to expect, and how MCP changes the decision.</p>
131131
</div>
@@ -290,7 +290,7 @@ <h2>Full reference docs</h2>
290290

291291
<footer>
292292
<div class="footer-inner">
293-
<span class="footer-logo">context-forge v1.1.0</span>
293+
<span class="footer-logo">context-forge v1.5.0</span>
294294
<div class="footer-links">
295295
<a href="quick-start.html">Quick start</a>
296296
<a href="languages.html">Languages</a>

0 commit comments

Comments
 (0)