diff --git a/README.md b/README.md index 828dcbe..2144454 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,8 @@ OPENAI_API_KEY=... npx --yes github:AgentsKit-io/code-review-cli \ The CLI reviews the current repository's diff against `origin/main` and prints the report in your terminal. Choose another base with `--base main`. +![AgentsKit Code Review showing an APPROVE result after seven review lenses complete](docs/assets/code-review-terminal.png) + The current command runs directly from GitHub. After the first npm release, the shorter form will be: ```sh diff --git a/docs/assets/code-review-terminal.png b/docs/assets/code-review-terminal.png new file mode 100644 index 0000000..1ebcc36 Binary files /dev/null and b/docs/assets/code-review-terminal.png differ diff --git a/llms-full.txt b/llms-full.txt index 818cb2e..39be2ff 100644 --- a/llms-full.txt +++ b/llms-full.txt @@ -78,6 +78,8 @@ OPENAI_API_KEY=... npx --yes github:AgentsKit-io/code-review-cli \ The CLI reviews the current repository's diff against `origin/main` and prints the report in your terminal. Choose another base with `--base main`. +![AgentsKit Code Review showing an APPROVE result after seven review lenses complete](https://raw.githubusercontent.com/AgentsKit-io/code-review-cli/main/docs/assets/code-review-terminal.png) + The current command runs directly from GitHub. After the first npm release, the shorter form will be: ```sh diff --git a/readme-standard-v1.json b/readme-standard-v1.json index b15c5e7..f6ce50e 100644 --- a/readme-standard-v1.json +++ b/readme-standard-v1.json @@ -137,6 +137,7 @@ ], "visuals": [ "docs/assets/agentskit-mark.svg", + "docs/assets/code-review-terminal.png", "```mermaid" ], "maturity": [ @@ -172,6 +173,11 @@ "src": "docs/assets/agentskit-mark.svg", "kind": "brand", "darkMode": "neutral" + }, + { + "src": "docs/assets/code-review-terminal.png", + "kind": "screenshot", + "darkMode": "neutral" } ], "commands": [ @@ -215,7 +221,7 @@ "docs/OPERATIONS.md", "test/cli-smoke.test.mjs" ], - "sourceHash": "sha256:9b6b6c25a9ccdde85eb1f5eb39b484a8b4ca726a783584d4c8606a3342baaa5c" + "sourceHash": "sha256:a5e91e2e53b23297102dfd01e9c203028873abce0fd84c17cb92206204f0df49" }, "exceptions": [] } diff --git a/scripts/generate-llms-full.mjs b/scripts/generate-llms-full.mjs index b44fd6a..f9d4bf9 100644 --- a/scripts/generate-llms-full.mjs +++ b/scripts/generate-llms-full.mjs @@ -19,10 +19,15 @@ const sources = [ ['Changelog', 'CHANGELOG.md'], ] -const rebaseRelativeLinks = (markdown, sourcePath) => markdown.replace( - /\]\((?!https?:\/\/|mailto:|#)([^)]+)\)/g, - (_match, target) => `](${new URL(target, `${blobBase}${sourcePath}`).href})`, -) +const rebaseRelativeLinks = (markdown, sourcePath) => markdown + .replace( + /!\[([^\]]*)\]\((?!https?:\/\/|mailto:|#)([^)]+)\)/g, + (_match, alt, target) => `![${alt}](${new URL(target, `${rawBase}${sourcePath}`).href})`, + ) + .replace( + /\]\((?!https?:\/\/|mailto:|#)([^)]+)\)/g, + (_match, target) => `](${new URL(target, `${blobBase}${sourcePath}`).href})`, + ) const ecosystem = JSON.parse(readFileSync(resolve(root, 'ecosystem.json'), 'utf8')) const productLines = ecosystem.products diff --git a/test/documentation.test.mjs b/test/documentation.test.mjs index 7fe7c8e..5853308 100644 --- a/test/documentation.test.mjs +++ b/test/documentation.test.mjs @@ -80,6 +80,8 @@ test('machine-readable documentation and Doc Bridge ownership are committed', () assert.match(read('llms.txt'), /AgentsKit Code Review/) assert.match(read('llms.txt'), /llms-full\.txt/) const full = read('llms-full.txt') + assert.match(full, /!\[[^\]]+\]\(https:\/\/raw\.githubusercontent\.com\/AgentsKit-io\/code-review-cli\/main\/docs\/assets\/code-review-terminal\.png\)/) + assert.doesNotMatch(full, /!\[[^\]]*\]\(https:\/\/github\.com\/AgentsKit-io\/code-review-cli\/blob\/main\//) for (const marker of ['Code Review operations guide', '## Security policy', '## Contributing guide', '## Roadmap', '## Changelog']) { assert.ok(full.includes(marker), `llms-full.txt missing ${marker}`) }