Skip to content

Commit 89d12c5

Browse files
committed
Revise README to improve clarity and structure of CLI examples
- Updated the README.md to enhance the presentation of key concepts, including pattern drift and preflight editing. - Replaced the previous table format with clearer headings and individual images for better readability. - Added new CLI examples to provide users with practical commands for navigating the codebase.
1 parent a2105ea commit 89d12c5

2 files changed

Lines changed: 17 additions & 22 deletions

File tree

README.md

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,23 @@ The index auto-refreshes as you edit - a file watcher triggers incremental reind
2626

2727
Real CLI output against `angular-spotify`, the repo used for the launch screenshots.
2828

29-
<table>
30-
<tr>
31-
<td width="50%">
32-
<strong>Patterns and team drift</strong><br />
33-
<img src="https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/patterns.png" alt="codebase-context patterns screenshot" />
34-
</td>
35-
<td width="50%">
36-
<strong>Edit preflight</strong><br />
37-
<img src="https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/search-query.png" alt="codebase-context search preflight screenshot" />
38-
</td>
39-
</tr>
40-
<tr>
41-
<td width="50%">
42-
<strong>Symbol references</strong><br />
43-
<img src="https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/refs-symbol.png" alt="codebase-context symbol references screenshot" />
44-
</td>
45-
<td width="50%">
46-
<strong>Codebase overview</strong><br />
47-
<img src="https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/metadata.png" alt="codebase-context metadata screenshot" />
48-
</td>
49-
</tr>
50-
</table>
29+
**Lead signal: pattern drift and golden files**
30+
31+
![codebase-context patterns screenshot](https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/patterns.png)
32+
33+
This is the part most tools miss: what the team is doing now, what it is moving away from, and which files are the best examples to follow.
34+
35+
**Before editing: preflight and impact**
36+
37+
![codebase-context search preflight screenshot](https://raw.githubusercontent.com/PatrickSys/codebase-context/master/docs/assets/search-query.png)
38+
39+
When the agent searches with edit intent, it gets a compact decision card: confidence, whether it's safe to proceed, which patterns apply, the best example, and which files are likely to be affected.
40+
41+
More CLI examples:
42+
43+
- `refs --symbol "ComponentStore"` for concrete static references
44+
- `metadata` for a quick codebase overview
45+
- Full gallery in `docs/cli.md`
5146

5247
## Quick Start
5348

291 Bytes
Loading

0 commit comments

Comments
 (0)