@chappibunny/repolens 1.14.0 → 1.14.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +29 -1
  2. package/README.md +13 -5
  3. package/package.json +17 -4
  4. package/src/docs/branding.js +1 -1
package/CHANGELOG.md CHANGED
@@ -2,6 +2,34 @@
2
2
 
3
3
  All notable changes to RepoLens will be documented in this file.
4
4
 
5
+ ## 1.14.2
6
+
7
+ ### Discoverability
8
+
9
+ - Docs badge line now links to the gallery (`[Examples](https://chapibunny.github.io/repolens/)`)
10
+ - Added `glama.json` (Glama MCP directory ownership) and `CITATION.cff`
11
+ - More npm keywords; npm `homepage` points at the gallery
12
+ - README: MCP Registry and Gallery badges and a links row
13
+
14
+
15
+ ### Gallery
16
+
17
+ Static showcase of deterministic RepoLens output for public repositories. The package version is unchanged.
18
+
19
+ - `gallery/build.mjs` shallow-clones the curated list in `gallery/repos.json`, runs RepoLens with AI disabled, and writes one HTML page per repository plus an index, `sitemap.xml`, and `robots.txt`
20
+ - A repository that fails to clone, fails the license check, or fails the scan is skipped. The build refuses to publish when too few repositories succeed
21
+ - `.github/workflows/gallery.yml` rebuilds the site weekly and on manual dispatch, caches clones, and deploys with GitHub Pages to `https://chapibunny.github.io/repolens/`
22
+ - `gallery/` stays out of the npm package: it is not in the `files` allowlist, and `/gallery` is listed in `.npmignore`
23
+ - Gallery pages use a flat Material layout: square corners, no shadows or gradients, one primary colour and one accent on white and light grey, a flat RepoLens app bar, and a dense repository table on the index. The same stylesheet covers each repository page
24
+
25
+ ## 1.14.1
26
+
27
+ ### Registry name and publish skip
28
+
29
+ - MCP Registry server name is `io.github.CHAPIBUNNY/repolens`. `package.json` `mcpName` and `server.json` `name` use that spelling. The registry matches the GitHub username case
30
+ - `server.json` `description` is 100 characters or fewer
31
+ - The release workflow skips `npm publish` when that exact version is already on the registry
32
+
5
33
  ## 1.14.0
6
34
 
7
35
  ### MCP server
@@ -14,7 +42,7 @@ AI coding tools can call RepoLens over stdio.
14
42
  - Every path stays inside the workspace root (`REPOLENS_WORKSPACE` or the working directory), using the existing `isInsideRoot` and `resolveOutputDir` helpers
15
43
  - Deterministic mode is the default and does not make network calls. Logs go to stderr so they do not corrupt the protocol
16
44
  - `get_architecture_diff` uses the existing git diff. `baseRef` compares against the working tree. `headRef` diffs two refs. Unsafe refs are rejected
17
- - `package.json` `mcpName` is `io.github.chapibunny/repolens`. Root `server.json` matches it for the MCP Registry. `smithery.yaml` starts `npx -y @chappibunny/repolens mcp`
45
+ - `package.json` `mcpName` is `io.github.CHAPIBUNNY/repolens`. Root `server.json` matches it for the MCP Registry. `smithery.yaml` starts `npx -y @chappibunny/repolens mcp`
18
46
  - Client setup, including Cursor and VS Code install badges, is in `docs/MCP.md`
19
47
 
20
48
  ### GitHub Action
package/README.md CHANGED
@@ -12,9 +12,13 @@
12
12
  [![VS Code Extension](https://img.shields.io/visual-studio-marketplace/v/repolensdox.repolensdox?label=VS%20Code)](https://marketplace.visualstudio.com/items?itemName=repolensdox.repolensdox)
13
13
  [![Tests](https://img.shields.io/github/actions/workflow/status/CHAPIBUNNY/repolens/test.yml?label=tests)](https://github.com/CHAPIBUNNY/repolens/actions/workflows/test.yml)
14
14
  [![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
15
+ [![MCP Registry](https://img.shields.io/badge/MCP_Registry-io.github.CHAPIBUNNY%2Frepolens-6E56CF)](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.CHAPIBUNNY/repolens)
16
+ [![Gallery](https://img.shields.io/badge/Gallery-26_real_repos-0B5FFF)](https://chapibunny.github.io/repolens/)
15
17
  [![Install in Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=repolens&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBjaGFwcGlidW5ueS9yZXBvbGVucyIsIm1jcCJdfQ%3D%3D)
16
18
  [![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_MCP_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=repolens&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40chappibunny%2Frepolens%22%2C%22mcp%22%5D%7D)
17
19
 
20
+ **Links:** [Gallery](https://chapibunny.github.io/repolens/) · [npm](https://www.npmjs.com/package/@chappibunny/repolens) · [MCP Registry](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.CHAPIBUNNY/repolens) · [VS Code extension](https://marketplace.visualstudio.com/items?itemName=repolensdox.repolensdox) · [GitHub Action](action.yml)
21
+
18
22
  **Your architecture docs are already outdated.** RepoLens fixes that.
19
23
 
20
24
  RepoLens scans your repository, generates living architecture documentation, and publishes it to Notion, Confluence, GitHub Wiki, Obsidian, or Markdown — automatically on every push. Engineers get technical docs. Stakeholders get readable system overviews. Nobody writes a word.
@@ -27,6 +31,8 @@ RepoLens scans your repository, generates living architecture documentation, and
27
31
 
28
32
  > **Try it now** — no installation required. Run `npx @chappibunny/repolens demo` on any repo for an instant local preview.
29
33
 
34
+ **[See it on real repos](https://chapibunny.github.io/repolens/)** — architecture pages RepoLens generated for Express, FastAPI, Django, Gin, mdBook, and other public projects. Deterministic mode, no API keys.
35
+
30
36
  🎬 **[Watch Demo Video](https://www.loom.com/share/8e077624e69f41319fd93acbbe03871e)** — See RepoLens generate docs in 60 seconds
31
37
 
32
38
  <table>
@@ -206,7 +212,7 @@ Copy-paste configs for Cursor, Claude Desktop, and VS Code are in [docs/MCP.md](
206
212
 
207
213
  ## GitHub Action
208
214
 
209
- `action.yml` is a composite action named **RepoLens Architecture Docs**. It runs the published npm package (`npx --yes @chappibunny/repolens@1.14.0`). Inputs are `command` (`publish`, `demo`, or `doctor`), `config`, `node-version`, `pr-comment`, and `version`.
215
+ `action.yml` is a composite action named **RepoLens Architecture Docs**. It runs the published npm package (`npx --yes @chappibunny/repolens@1.14.1`). Inputs are `command` (`publish`, `demo`, or `doctor`), `config`, `node-version`, `pr-comment`, and `version`.
210
216
 
211
217
  ```yaml
212
218
  name: Architecture docs
@@ -222,7 +228,7 @@ jobs:
222
228
  runs-on: ubuntu-latest
223
229
  steps:
224
230
  - uses: actions/checkout@9f698171ed81b15d1823a05fc7211befd50c8ae0 # v6.0.3
225
- - uses: CHAPIBUNNY/repolens@v1.14.0
231
+ - uses: CHAPIBUNNY/repolens@v1.14.1
226
232
  with:
227
233
  command: publish
228
234
  config: .repolens.yml
@@ -230,16 +236,18 @@ jobs:
230
236
  pr-comment: ${{ github.event_name == 'pull_request' && 'true' || 'false' }}
231
237
  ```
232
238
 
233
- The action is listed on the GitHub Marketplace only after a release is published with **Publish this Action to the GitHub Marketplace** checked. Those steps are in [docs/RELEASE.md](docs/RELEASE.md). The tag `v1.14.0` has to exist before `uses: CHAPIBUNNY/repolens@v1.14.0` resolves, and `@chappibunny/repolens@1.14.0` has to be on npm before the action can install it.
239
+ The action is listed on the GitHub Marketplace only after a release is published with **Publish this Action to the GitHub Marketplace** checked. Those steps are in [docs/RELEASE.md](docs/RELEASE.md). The tag `v1.14.1` has to exist before `uses: CHAPIBUNNY/repolens@v1.14.1` resolves, and `@chappibunny/repolens@1.14.1` has to be on npm before the action can install it.
234
240
 
235
241
  ## Add the badge to your repo
236
242
 
237
243
  Generated Markdown includes this line unless `.repolens.yml` sets `branding: false` (or `branding.badge: false`). Add the same badge to a repository README:
238
244
 
239
245
  ```markdown
240
- [![Docs by RepoLens](https://img.shields.io/badge/Docs%20by-RepoLens-0B5FFF)](https://github.com/CHAPIBUNNY/repolens)
246
+ [![Docs by RepoLens](https://img.shields.io/badge/Docs%20by-RepoLens-0B5FFF)](https://github.com/CHAPIBUNNY/repolens) · [Examples](https://chapibunny.github.io/repolens/)
241
247
  ```
242
248
 
249
+ Generated docs also link to the [gallery](https://chapibunny.github.io/repolens/) after the badge.
250
+
243
251
  ---
244
252
 
245
253
  ## 📸 Example Output
@@ -248,7 +256,7 @@ Generated Markdown includes this line unless `.repolens.yml` sets `branding: fal
248
256
 
249
257
  Published system maps are Unicode diagrams drawn from import edges. RepoLens does not emit Mermaid.
250
258
 
251
- The publisher set is Notion, Confluence, GitHub Wiki, Obsidian, and Markdown (`src/publishers`, 7 files). 1.14.0 adds the MCP server, the Marketplace action, and the docs badge. Layout and counts are in [ARCHITECTURE.md](docs/ARCHITECTURE.md).
259
+ The publisher set is Notion, Confluence, GitHub Wiki, Obsidian, and Markdown (`src/publishers`, 7 files). 1.14.0 adds the MCP server, the Marketplace action, and the docs badge. 1.14.1 sets the registry name to `io.github.CHAPIBUNNY/repolens`. 1.14.2 adds the gallery link to the badge line, `glama.json`, and `CITATION.cff`. Layout and counts are in [ARCHITECTURE.md](docs/ARCHITECTURE.md).
252
260
 
253
261
  ### System Overview (Technical Profile)
254
262
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@chappibunny/repolens",
3
- "version": "1.14.0",
4
- "mcpName": "io.github.chapibunny/repolens",
3
+ "version": "1.14.2",
4
+ "mcpName": "io.github.CHAPIBUNNY/repolens",
5
5
  "description": "AI-assisted documentation intelligence system for technical and non-technical audiences",
6
6
  "license": "MIT",
7
7
  "type": "module",
@@ -41,13 +41,26 @@
41
41
  "obsidian",
42
42
  "ai-documentation",
43
43
  "mcp",
44
- "model-context-protocol"
44
+ "model-context-protocol",
45
+ "architecture-documentation",
46
+ "documentation-generator",
47
+ "docs-as-code",
48
+ "living-documentation",
49
+ "dependency-graph",
50
+ "codebase-analysis",
51
+ "static-analysis",
52
+ "mcp-server",
53
+ "github-action",
54
+ "vscode",
55
+ "code-documentation",
56
+ "software-architecture",
57
+ "ai"
45
58
  ],
46
59
  "repository": {
47
60
  "type": "git",
48
61
  "url": "git+https://github.com/CHAPIBUNNY/repolens.git"
49
62
  },
50
- "homepage": "https://github.com/CHAPIBUNNY/repolens#readme",
63
+ "homepage": "https://chapibunny.github.io/repolens/",
51
64
  "bugs": {
52
65
  "url": "https://github.com/CHAPIBUNNY/repolens/issues"
53
66
  },
package/src/docs/branding.js CHANGED
@@ -6,7 +6,7 @@
6
6
  export const DOCS_BADGE_MARKER = "<!-- repolens:docs-badge -->";
7
7
 
8
8
  export const DOCS_BADGE_MARKDOWN =
9
- "[![Docs by RepoLens](https://img.shields.io/badge/Docs%20by-RepoLens-0B5FFF)](https://github.com/CHAPIBUNNY/repolens)";
9
+ "[![Docs by RepoLens](https://img.shields.io/badge/Docs%20by-RepoLens-0B5FFF)](https://github.com/CHAPIBUNNY/repolens) · [Examples](https://chapibunny.github.io/repolens/)";
10
10
 
11
11
  export function brandingEnabled(config) {
12
12
  const branding = config?.branding;