@papi-ai/adapter-md 0.1.0-alpha
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 +29 -0
- package/dist/index.d.ts +904 -0
- package/dist/index.js +2398 -0
- package/package.json +45 -0
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# @papi/adapter-md
|
|
2
|
+
|
|
3
|
+
Markdown file adapter for PAPI. Reads and writes `.papi/` project files — sprint boards, build reports, active decisions, and planning logs.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This adapter implements the `PapiAdapter` interface using local markdown files as the storage backend. It's the default adapter for offline/local usage and is bundled into `@papi/server`.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @papi/adapter-md
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
You typically don't need to install this directly — it's bundled into `@papi/server` at build time. Install separately only if building custom tooling.
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
The adapter reads from and writes to a `.papi/` directory in your project root:
|
|
20
|
+
|
|
21
|
+
- `PRODUCT_BRIEF.md` — Project vision and roadmap
|
|
22
|
+
- `SPRINT_BOARD.md` — Tasks with status, priority, and build handoffs
|
|
23
|
+
- `BUILD_REPORTS.md` — Post-build reports with effort and discoveries
|
|
24
|
+
- `PLANNING_LOG.md` — Sprint history and active decisions
|
|
25
|
+
- `REVIEWS.md` — Human review records
|
|
26
|
+
|
|
27
|
+
## License
|
|
28
|
+
|
|
29
|
+
MIT
|