Skip to content

Commit a123e83

Browse files
committed
docs: update all pages to v2.4.0 (340 tests, programmatic API)
1 parent 2a5595d commit a123e83

11 files changed

Lines changed: 37 additions & 23 deletions

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
<!-- Status -->
1313
[![npm version](https://img.shields.io/npm/v/sigmap?color=7c6af7&label=latest&logo=npm)](https://www.npmjs.com/package/sigmap)
14-
[![Tests](https://img.shields.io/badge/tests-325%20passing-22c55e)](https://github.com/manojmallick/sigmap/tree/main/test)
14+
[![Tests](https://img.shields.io/badge/tests-340%20passing-22c55e)](https://github.com/manojmallick/sigmap/tree/main/test)
1515
[![Zero deps](https://img.shields.io/badge/dependencies-zero-22c55e)](package.json)
1616
[![Last commit](https://img.shields.io/github/last-commit/manojmallick/sigmap?color=7c6af7)](https://github.com/manojmallick/sigmap/commits/main)
1717

@@ -86,6 +86,15 @@ AI agent session starts with full context
8686
8787
---
8888

89+
## 🆕 What's new in 2.4
90+
91+
| Feature | Description |
92+
|---|---|
93+
| **Programmatic API** | `require('sigmap')` — use `extract`, `rank`, `buildSigIndex`, `scan`, `score` directly, no CLI subprocess |
94+
| **`packages/core/`** | New `sigmap-core` package with stable API surface for third-party integrations |
95+
| **`packages/cli/`** | Thin `sigmap-cli` forward-compat shim for the v3.0 adapter architecture |
96+
| **15 new tests** | `core-api.test.js` covers all exported functions, edge cases, and backward compat |
97+
8998
## 🆕 What's new in 2.3
9099

91100
| Feature | Description |

docs/cli.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@
163163

164164
<div class="page-hero">
165165
<div class="hero-inner">
166-
<div class="hero-badge"><span class="dot"></span>v2.3.0</div>
166+
<div class="hero-badge"><span class="dot"></span>v2.4.0</div>
167167
<h1>CLI Reference</h1>
168168
<p class="hero-sub">Every flag, with examples. Run <code style="font-family:'IBM Plex Mono',monospace;font-size:15px;background:rgba(124,106,247,.12);padding:2px 8px;border-radius:5px;-webkit-text-fill-color:var(--pd)">sigmap --help</code> to see the full list.</p>
169169
</div>
@@ -185,7 +185,7 @@ <h2>All flags at a glance</h2>
185185
<span class="term-title">node gen-context.js --help</span>
186186
</div>
187187
<div class="term-body">
188-
<div><span class="tp">SigMap v2.3.0</span></div>
188+
<div><span class="tp">SigMap v2.4.0</span></div>
189189
<div>&nbsp;</div>
190190
<div><span class="tc">Usage:</span> <span class="tw">node gen-context.js [flag]</span></div>
191191
<div>&nbsp;</div>
@@ -575,7 +575,7 @@ <h3>--version</h3>
575575
</div>
576576
<div class="term-body">
577577
<div><span class="tc">$</span> <span class="tw">node gen-context.js --version</span></div>
578-
<div><span class="ts">sigmap/2.3.0</span></div>
578+
<div><span class="ts">sigmap/2.4.0</span></div>
579579
</div>
580580
</div>
581581
</div>
@@ -609,7 +609,7 @@ <h2>Explore further</h2>
609609

610610
<footer>
611611
<div class="footer-inner">
612-
<span class="footer-logo">sigmap v2.3.0</span>
612+
<span class="footer-logo">sigmap v2.4.0</span>
613613
<div class="footer-links">
614614
<a href="quick-start.html">Quick start</a>
615615
<a href="cli.html">CLI reference</a>

docs/config.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ <h2>Explore further</h2>
472472

473473
<footer>
474474
<div class="footer-inner">
475-
<span class="footer-logo">sigmap v2.3.0</span>
475+
<span class="footer-logo">sigmap v2.4.0</span>
476476
<div class="footer-links">
477477
<a href="quick-start.html">Quick start</a>
478478
<a href="cli.html">CLI reference</a>

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<meta name="twitter:image" content="https://manojmallick.github.io/sigmap/sigmap-banner.png">
1414
<link rel="canonical" href="https://manojmallick.github.io/sigmap/">
1515
<link rel="sitemap" type="application/xml" href="https://manojmallick.github.io/sigmap/sitemap.xml">
16-
<script type="application/ld+json">{"@context":"https://schema.org","@type":"SoftwareApplication","name":"SigMap","applicationCategory":"DeveloperApplication","description":"Zero-dependency AI context engine. 97% token reduction for AI coding agents. Extracts signatures from 21 languages. No npm install.","url":"https://manojmallick.github.io/sigmap/","downloadUrl":"https://www.npmjs.com/package/sigmap","softwareVersion":"2.3.0","operatingSystem":"Any (Node.js 18+)","offers":{"@type":"Offer","price":"0","priceCurrency":"USD"},"author":{"@type":"Person","name":"Manoj Mallick","url":"https://github.com/manojmallick"}}</script>
16+
<script type="application/ld+json">{"@context":"https://schema.org","@type":"SoftwareApplication","name":"SigMap","applicationCategory":"DeveloperApplication","description":"Zero-dependency AI context engine. 97% token reduction for AI coding agents. Extracts signatures from 21 languages. No npm install.","url":"https://manojmallick.github.io/sigmap/","downloadUrl":"https://www.npmjs.com/package/sigmap","softwareVersion":"2.4.0","operatingSystem":"Any (Node.js 18+)","offers":{"@type":"Offer","price":"0","priceCurrency":"USD"},"author":{"@type":"Person","name":"Manoj Mallick","url":"https://github.com/manojmallick"}}</script>
1717
<link href="https://fonts.googleapis.com/css2?family=Syne:wght@700;800&family=IBM+Plex+Mono:wght@400;500&family=DM+Sans:wght@300;400;500;600&display=swap" rel="stylesheet">
1818
<script>(function(){var r=document.documentElement;if(localStorage.getItem('cf-theme')==='light')r.classList.add('light');document.addEventListener('DOMContentLoaded',function(){document.querySelectorAll('.theme-toggle').forEach(function(b){b.addEventListener('click',function(){r.classList.toggle('light');localStorage.setItem('cf-theme',r.classList.contains('light')?'light':'dark');});});});})();</script>
1919
<style>
@@ -438,7 +438,7 @@ <h2>Built for the community</h2>
438438
<!-- FOOTER -->
439439
<footer>
440440
<div class="footer-inner">
441-
<span class="footer-logo">sigmap v2.3.0</span>
441+
<span class="footer-logo">sigmap v2.4.0</span>
442442
<div class="footer-links">
443443
<a href="quick-start.html">Quick start</a>
444444
<a href="cli.html">CLI reference</a>

docs/languages.html

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

620620
<footer>
621621
<div class="footer-inner">
622-
<span class="footer-logo">sigmap v2.3.0</span>
622+
<span class="footer-logo">sigmap v2.4.0</span>
623623
<div class="footer-links">
624624
<a href="quick-start.html">Quick start</a>
625625
<a href="cli.html">CLI reference</a>

docs/mcp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ <h2>Explore further</h2>
512512

513513
<footer>
514514
<div class="footer-inner">
515-
<span class="footer-logo">sigmap v2.3.0</span>
515+
<span class="footer-logo">sigmap v2.4.0</span>
516516
<div class="footer-links">
517517
<a href="quick-start.html">Quick start</a>
518518
<a href="cli.html">CLI reference</a>

docs/quick-start.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ <h2>Command reference</h2>
442442
<span class="term-title">node gen-context.js --help</span>
443443
</div>
444444
<div class="term-body">
445-
<div><span class="tp">SigMap v2.3.0</span></div>
445+
<div><span class="tp">SigMap v2.4.0</span></div>
446446
<div>&nbsp;</div>
447447
<div><span class="tc">Usage:</span> <span class="tw">node gen-context.js [flag]</span></div>
448448
<div>&nbsp;</div>
@@ -486,16 +486,16 @@ <h2>Explore further</h2>
486486
<div class="next-card-desc">Stack both tools for the two-layer caching strategy. SigMap for daily; Repomix for deep sessions.</div>
487487
</a>
488488
<a class="next-card" href="roadmap.html">
489-
<div class="next-card-ey">v0.1 → v2.3</div>
489+
<div class="next-card-ey">v0.1 → v2.4</div>
490490
<div class="next-card-title">Full roadmap</div>
491-
<div class="next-card-desc">All major versions shipped. 97% token reduction. 325 tests. MIT license.</div>
491+
<div class="next-card-desc">All major versions shipped. 97% token reduction. 340 tests. MIT license.</div>
492492
</a>
493493
</div>
494494
</section>
495495

496496
<footer>
497497
<div class="footer-inner">
498-
<span class="footer-logo">sigmap v2.3.0</span>
498+
<span class="footer-logo">sigmap v2.4.0</span>
499499
<div class="footer-links">
500500
<a href="quick-start.html">Quick start</a>
501501
<a href="cli.html">CLI reference</a>

docs/repomix.html

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

519519
<footer>
520520
<div class="footer-inner">
521-
<span class="footer-logo">sigmap v2.3.0</span>
521+
<span class="footer-logo">sigmap v2.4.0</span>
522522
<div class="footer-links">
523523
<a href="quick-start.html">Quick start</a>
524524
<a href="cli.html">CLI reference</a>

docs/roadmap.html

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>Roadmap — SigMap</title>
77
<meta name="description" content="SigMap shipped v0.1 through v2.4 — 21 versions, 97% token reduction, 340 tests. Full visual timeline from baseline to complete system.">
88
<meta property="og:title" content="SigMap Roadmap — v0.1 to v2.4 complete">
9-
<meta property="og:description" content="20 versions shipped. 97% token reduction. 325 tests. MIT license. See how SigMap was built from first extractor to full enterprise system.">
9+
<meta property="og:description" content="21 versions shipped. 97% token reduction. 340 tests. MIT license. See how SigMap was built from first extractor to full enterprise system.">
1010
<meta property="og:url" content="https://manojmallick.github.io/sigmap/roadmap.html">
1111
<meta name="twitter:card" content="summary_large_image">
1212
<meta property="og:image" content="https://manojmallick.github.io/sigmap/sigmap-banner.png">
@@ -147,10 +147,10 @@
147147
<div class="hero-inner">
148148
<div class="hero-badge"><span class="dot"></span>All versions complete</div>
149149
<h1>v0.0 → v2.4</h1>
150-
<p class="hero-sub">Twenty versions. Every one shipped. MIT open source from day one.</p>
150+
<p class="hero-sub">Twenty-one versions. Every one shipped. MIT open source from day one.</p>
151151
<div class="hero-stats">
152152
<div class="hstat"><span class="hstat-val p">97%</span><span class="hstat-lbl">Token reduction</span></div>
153-
<div class="hstat"><span class="hstat-val g">325</span><span class="hstat-lbl">Tests passing</span></div>
153+
<div class="hstat"><span class="hstat-val g">340</span><span class="hstat-lbl">Tests passing</span></div>
154154
<div class="hstat"><span class="hstat-val g">21</span><span class="hstat-lbl">Languages</span></div>
155155
<div class="hstat"><span class="hstat-val g">0</span><span class="hstat-lbl">npm deps</span></div>
156156
</div>
@@ -227,6 +227,11 @@ <h2>Reduction by version</h2>
227227
<div class="tp-bar-bg"><div class="tp-bar" style="width:0.5%;background:var(--p)"></div></div>
228228
<div class="tp-val" style="color:var(--pd)">+query retrieval</div>
229229
</div>
230+
<div class="tp-row">
231+
<div class="tp-ver">v2.4</div>
232+
<div class="tp-bar-bg"><div class="tp-bar" style="width:0.5%;background:var(--p)"></div></div>
233+
<div class="tp-val" style="color:var(--pd)">+programmatic API</div>
234+
</div>
230235
</div>
231236
</section>
232237

docs/strategies.html

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

131131
<div class="page-hero">
132132
<div class="hero-inner">
133-
<div class="hero-badge">strategy guide — current as of v2.3</div>
133+
<div class="hero-badge">strategy guide — current as of v2.4</div>
134134
<h1>Choose the right context strategy</h1>
135135
<p class="hero-sub">SigMap 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>
136136
</div>
@@ -295,7 +295,7 @@ <h2>Full reference docs</h2>
295295

296296
<footer>
297297
<div class="footer-inner">
298-
<span class="footer-logo">sigmap v2.3.0</span>
298+
<span class="footer-logo">sigmap v2.4.0</span>
299299
<div class="footer-links">
300300
<a href="quick-start.html">Quick start</a>
301301
<a href="cli.html">CLI reference</a>

0 commit comments

Comments
 (0)