Skip to content

Commit 5ffc288

Browse files
committed
docs: update README to match shipped V1 (no vscode_ref, bundled dist)
1 parent 8581a59 commit 5ffc288

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ You need **one secret**: an LLM API key. OpenRouter is the default; pass your ow
5050
| `llm_api_key` | (required) | LLM API key. Currently OpenRouter (`OPENROUTER_API_KEY`). |
5151
| `github_token` | `${{ github.token }}` | Token used to post the comment and push the image. |
5252
| `engine_ref` | `main` | Git ref of `CodeBoarding/CodeBoarding`. Pin in production. |
53-
| `vscode_ref` | `main` | Git ref of `CodeBoarding/CodeBoarding-vscode`. Pin in production. |
5453
| `depth_level` | `1` | Diagram depth (1–3). Higher = slower + more detail. |
5554
| `agent_model` | `openrouter/anthropic/claude-sonnet-4` | LLM for analysis. |
5655
| `parsing_model` | `openrouter/anthropic/claude-sonnet-4` | LLM for parsing. |
@@ -69,7 +68,10 @@ You need **one secret**: an LLM API key. OpenRouter is the default; pass your ow
6968

7069
The action reads the `.codeboarding/analysis.json` that was committed at the PR base commit. If your repo has never been analyzed, the first PR will skip the diff and post a "no baseline yet" comment.
7170

72-
To create the baseline, run the existing CodeBoarding docs workflow once on `main`. It will commit a fresh `analysis.json` to `.codeboarding/`. After that, every PR shows what changed.
71+
To create the baseline:
72+
73+
1. Run the existing CodeBoarding docs workflow ([`CodeBoarding/.github/workflows/docs.yml`](https://github.com/CodeBoarding/CodeBoarding/blob/main/.github/workflows/docs.yml)) once on `main`. It commits a fresh `.codeboarding/analysis.json` to your repo.
74+
2. After that, every PR opened against `main` shows what changed.
7375

7476
We recommend a companion workflow that keeps the baseline fresh on every push to `main`. A pre-canned snippet for this is on the roadmap — see TODOs below.
7577

@@ -84,6 +86,7 @@ PRs from forks cannot push to your image branch. The action still computes the d
8486
- **No focus / crop mode** for huge diagrams with tiny changes — the whole graph is rendered. Coming in V2.
8587
- **Re-clones the target repo** inside the analysis engine (legacy `generate_analysis()` API). One extra clone per run; harmless but measurable on huge repos.
8688
- **Image branch grows unbounded.** A scheduled cleanup workflow is on the roadmap.
89+
- **Webview bundle is committed in this repo** (`webview-dist/`). Until the upstream `CodeBoarding-vscode` repo ships its dist as a public release asset, rebuilding is a manual step: `cd CodeBoarding-vscode/webview-ui && npm ci && npm run build`, then copy `dist/` into this repo's `webview-dist/`.
8790

8891
## TODOs (require changes outside this repo)
8992

0 commit comments

Comments
 (0)