Skip to content

Commit 15cda76

Browse files
committed
refactor: update .gitignore and remove obsolete documentation files; enhance README and KnowCode.md for clarity
1 parent 9a69740 commit 15cda76

6 files changed

Lines changed: 58 additions & 266 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,4 +210,6 @@ __marimo__/
210210
knowcode_knowledge.json
211211
CHANGELOG.md
212212
docs_test/
213+
KnowCode.md
214+
docs/
213215

KnowCode.md

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -715,22 +715,38 @@ You've essentially defined a **code intelligence system**, not a chatbot with em
715715
## **Implementation Status & Roadmap**
716716

717717
### **Phase 1: Foundation (COMPLETED)**
718-
1. **[x] Unified Semantic Graph (Layer 3)**: Multi-language support (Python, JS, Java, MD, YAML).
719-
2. **[x] Token-Budgeted Synthesis (Layer 9)**: Priority-ranked context generation.
720-
3. **[x] Local Knowledge Store (Layer 8)**: JSON persistence with graph-like querying.
721-
4. **[x] Service Layer (Architecture Substrate)**: Unified business logic for CLI and API.
722-
723-
### **Phase 2: Intelligence Server (COMPLETED)**
724-
5. **[x] FastAPI Server (Layer 10)**: REST API for local IDE agent integration.
725-
6. **[x] Hot Reload (Layer 8)**: Dynamic refresh of knowledge store without downtime.
726-
7. **[x] Granular API (Layer 8)**: Programmatic access to raw entities and relationships.
727-
728-
### **Phase 3: Deep Analysis (NEXT)**
729-
8. **[ ] Static Behavioral Analysis (Layer 4)**: Data flow and state transition tracking.
730-
9. **[ ] Intent Extraction (Layer 6)**: Linking commit messages and ADRs to semantic nodes.
731-
10. **[ ] Confidence Scoring (Layer 3)**: Weighted edges based on analysis source quality.
732-
733-
### **Phase 4: Enterprise (FUTURE)**
734-
11. **[ ] Security & RBAC**: Who can query what modules.
735-
12. **[ ] Scalability**: Supporting monorepos > 1M LOC.
736-
13. **[ ] Team Sharing**: Remote knowledge store synchronization.
718+
1. **[x] Source Scanning + Parsing (Layers 1-2)**: Scanner with gitignore support; parsers for Python (AST), JS/TS + Java (Tree-sitter), Markdown, YAML.
719+
2. **[x] Unified Semantic Graph (Layer 3)**: Entity/relationship model with reference resolution (calls/imports/contains/inherits).
720+
3. **[x] Local Knowledge Store (Layer 8)**: In-memory graph with JSON persistence and query helpers.
721+
4. **[x] Token-Budgeted Context Synthesis (Layer 9)**: Priority-ordered sections with truncation handling.
722+
5. **[x] Service Layer**: Shared business logic for CLI and API.
723+
724+
### **Phase 2: Intelligence Server & RAG (COMPLETED)**
725+
6. **[x] FastAPI Server (Layer 10)**: Health, stats, search, context, semantic query, reload, entity details, callers/callees.
726+
7. **[x] Semantic Search & Indexing (Layer 4a)**: Chunker (module header/imports/entities), OpenAI embeddings, FAISS vector store, hybrid BM25+vector retrieval (RRF), reranking, dependency expansion.
727+
8. **[x] Indexer Persistence + CLI**: `index`/`semantic-search` commands with save/load.
728+
9. **[x] Watch Mode**: Background indexer + filesystem monitor for incremental re-indexing.
729+
10. **[x] CLI Workflows**: `analyze`, `query`, `context`, `export`, `stats`, `server`, `history`, `ask`.
730+
731+
### **Phase 3: Temporal & Runtime Signals (COMPLETED)**
732+
11. **[x] Git History Ingestion (Temporal)**: Commit/author entities, authored/modified/changed_by relationships; surfaced via `--temporal` and `history`.
733+
12. **[x] Coverage Signals (Layer 5)**: Cobertura ingestion with coverage report entities and covers/executed_by relationships.
734+
735+
### **Phase 4: Documentation Synthesis (PARTIAL)**
736+
13. **[x] Markdown Export (MVP)**: CLI `export` produces an index-style Markdown doc (see `docs_test/index.md`).
737+
14. **[ ] Multi-Level Doc Synthesis (Layer 7)**: Architecture/module/function narratives, change summaries, and freshness tracking.
738+
739+
### **Phase 5: Deep Analysis (NEXT)**
740+
15. **[ ] Static Behavioral Analysis (Layer 4)**: Data flow, state transitions, side-effect classification.
741+
16. **[ ] Intent Extraction (Layer 6)**: ADR/PR/commit intent linking beyond commit metadata.
742+
17. **[ ] Confidence Scoring (Layer 3)**: Weighted edges/entities by evidence source.
743+
744+
### **Phase 6: Enterprise (FUTURE)**
745+
18. **[ ] Security & RBAC**: Permissioned access and audit trails.
746+
19. **[ ] Scalability**: Large monorepo support and distributed processing.
747+
20. **[ ] Team Sharing**: Remote knowledge store sync and collaboration.
748+
749+
### **Supporting Tooling & QA (COMPLETED)**
750+
- **[x] Tests**: Unit/integration/e2e coverage for parsing, indexing, retrieval, API, CLI, storage, and analysis.
751+
- **[x] CI/CD**: Ruff linting, pytest + coverage, MkDocs build, and automated changelog generation.
752+
- **[x] Evaluation Utilities**: Retrieval-quality evaluation script (`scripts/evaluate.py`).

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ KnowCode analyzes your codebase and builds a semantic graph of entities (functio
1818

1919
```bash
2020
# Create and activate virtual environment
21-
python3 -m venv venv
22-
source venv/bin/activate # On Windows: venv\Scripts\activate
21+
uv venv
22+
source .venv/bin/activate # On Windows: .venv\Scripts\activate
2323

24-
# Install KnowCode
25-
pip install -e ".[dev]"
24+
# Install KnowCode (with dev dependencies)
25+
uv sync --dev
2626
```
2727

2828
## Quick Start

docs/evolution.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/index.md

Lines changed: 0 additions & 208 deletions
This file was deleted.

src/knowcode/models.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""Compatibility module for legacy imports.
2+
3+
Re-exports data model symbols from knowcode.data_models.
4+
"""
5+
6+
from knowcode.data_models import ( # noqa: F401
7+
ChunkingConfig,
8+
CodeChunk,
9+
EmbeddingConfig,
10+
Entity,
11+
EntityKind,
12+
Location,
13+
ParseResult,
14+
Relationship,
15+
RelationshipKind,
16+
)
17+

0 commit comments

Comments
 (0)