Skip to content

Commit f630ad4

Browse files
committed
wip:RAG pipeline:general structure #6 - docs(about): write introduction, align contributing with the Python flow
1 parent 4789517 commit f630ad4

2 files changed

Lines changed: 10 additions & 16 deletions

File tree

docs/about/contributing.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,7 @@ We rely on [Semantic Versioning](https://semver.org/) for versioning a release.
7171
* `MINOR` version when you add functionality in a backwards-compatible manner
7272
* `PATCH` version when you make backwards-compatible bug fixes.
7373

74-
The command `npm run release:<type>`, where `<type>` is either `patch`, `minor` or `major`, helps you to do the release.
75-
76-
It performs the following task for you:
77-
* increase the package version number in the `package.json` file
78-
* generate the change log
79-
* create a tag accordingly in the git repository and push it
74+
To cut a release: bump the `version` field in `pyproject.toml`, commit it, then create the matching git tag and push it (the published releases are driven by git tags).
8075

8176
## Contributor Code of Conduct
8277

docs/about/introduction.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ sidebarDepth: 3
77
<!-- TODO: 1-2 paragraphs — what knowledge is, in plain terms. -->
88

99
**knowledge** is an AI developer assistant for the Kalisio ecosystem. It indexes the
10-
entire codebase into a vector database and exposes it to coding agents through an [MCP](https://modelcontextprotocol.io/) server, so that
11-
agents retrieve only the chunks relevant to a task instead of reading whole files.
10+
entire codebase into a vector database and serves it to coding agents through a retrieval
11+
API, so that agents retrieve only the chunks relevant to a task instead of reading whole files.
1212

1313
## The problem
1414

@@ -21,12 +21,12 @@ agents retrieve only the chunks relevant to a task instead of reading whole file
2121

2222
- **Semantic code search** — retrieval over an indexed vector database.
2323
See [RAG: indexing & retrieval](/architecture/rag).
24-
- **Git intelligence**hotspots, co-change, bus factor.
25-
See [Git intelligence](/architecture/git-intelligence).
26-
- **Dependency graph**import graph and impact analysis.
27-
See [Dependency graph](/architecture/dependency-graph).
28-
- **MCP tools**the surface agents actually call.
29-
See [MCP tools](/architecture/mcp-tools).
24+
- **Structure-aware ingestion**per–file-type chunking (Markdown, JS, Vue, JSON), with
25+
incremental re-indexing of only what changed. See [Ingestion pipeline](/architecture/ingestion-pipeline).
26+
- **Commit-history enrichment**each chunk carries its file's recent commit history, so
27+
answers reflect how a file changed. See [Ingestion pipeline](/architecture/ingestion-pipeline).
28+
- **Retrieval API**`/ask` (RAG answer) and `/search` (chunks), JWT-secured.
29+
See [API endpoints](/architecture/api).
3030

3131
## How it fits the Kalisio ecosystem
3232

@@ -35,6 +35,5 @@ agents retrieve only the chunks relevant to a task instead of reading whole file
3535

3636
## Next steps
3737

38-
- New here? Read [Understanding knowledge](/guides/understanding).
39-
- Want to run it? See [Getting started](/guides/getting-started).
4038
- Curious about the internals? Start with the [Architecture overview](/architecture/introduction).
39+
- Want the research behind the design? See [Research](/research/introduction) and [Experiments](/experiments/introduction).

0 commit comments

Comments
 (0)