Skip to content

updated readme #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sagarwaal merged 1 commit into from
Oct 20, 2026
Merged

updated readme #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The generated knowledge lives inside the target project in `.codeintel/` and is

## Why

AI coding agents can lose useful context between sessions and may make incomplete changes when they do not understand the wider system. Project Intelligence gives them a structured, maintainable map of the codebase—with explicit evidence, uncertainty, and refresh guidance.
AI coding agents can lose useful context between sessions and may make incomplete changes when they do not understand the wider system. Codeintel gives them a structured, maintainable map of the codebase—with explicit evidence, uncertainty, and refresh guidance.

It is designed to answer questions such as:

Expand Down Expand Up @@ -169,7 +169,7 @@ Because the knowledge directory is ignored, it is not automatically shared with

## Limitations

Project Intelligence is an analysis workflow, not a guarantee of exhaustive correctness. Results depend on repository access, available tools, execution time, static-analysis capabilities, test setup, and the parts of the code actually inspected.
Codeintel is an analysis workflow, not a guarantee of exhaustive correctness. Results depend on repository access, available tools, execution time, static-analysis capabilities, test setup, and the parts of the code actually inspected.

Dynamic dispatch, reflection, generated code, runtime registration, external consumers, and undocumented production behavior may limit certainty. The skill is instructed to record these limitations rather than claim complete coverage.

Expand Down Expand Up @@ -200,14 +200,6 @@ Dynamic dispatch, reflection, generated code, runtime registration, external con
└── LICENSE
```

### Releasing

```bash
scripts/validate.sh --bump 1.1.0 # sets the version in every manifest and validates
# update CHANGELOG.md, commit, then:
git tag v1.1.0 && git push --follow-tags
```

## Contributing

Contributions are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md).
Expand Down
Loading