docit-ai 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# docit-ai
|
|
2
|
+
|
|
3
|
+
Docit is a CLI-first, npm-distributed tool that generates and automatically updates technical documentation for software projects. It is designed to be a high-performance, affordable alternative to Mintlify. It utilizes local parsing (AST) combined with cost-effective LLMs (Gemini 2.5 Flash-Lite) to keep token costs minimal.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
### Persona-Based Views
|
|
8
|
+
|
|
9
|
+
Docit formats the AI output into three distinct sections within the generated documentation:
|
|
10
|
+
|
|
11
|
+
1. **Strategic View (For Project Managers)**: Focuses on business value and status. Includes high-level summaries and a "Completeness Score".
|
|
12
|
+
2. **Technical View (For Developers)**: Focuses on architecture and integration. Includes function signatures, dependency maps, and "How to use" code examples.
|
|
13
|
+
3. **Personal View (For Individuals)**: Focuses on productivity and reminders. Includes a "To-Do" list generated from TODO comments and a "Technical Debt" summary.
|
|
14
|
+
|
|
15
|
+
### Core Architecture
|
|
16
|
+
|
|
17
|
+
- **Scanner**: Uses simple-git to identify files modified in the last commit.
|
|
18
|
+
- **Parser**: Uses tree-sitter to extract "Code Skeletons" (function names, parameters, return types, and comments) to reduce token usage.
|
|
19
|
+
- **Engine**: Orchestrates calls to the LLM (Default: Gemini 2.5 Flash-Lite).
|
|
20
|
+
- **Formatter**: Generates three distinct views of the documentation.
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install -g docit-ai
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
The main command to generate documentation is `sync`.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
docit-ai sync
|
|
34
|
+
```
|