22
33[ 中文] ( README.zh-CN.md )
44
5- OpenKnowForge is an API-native, Git-backed knowledge base system.
6- It connects note authoring , metadata governance, static publishing, and version traceability into one workflow.
5+ OpenKnowForge is an API-native, Git-backed knowledge engineering system.
6+ It unifies content generation , metadata governance, static publishing, and version traceability into a single workflow.
77
88## OpenClaw-First Workflow (No Manual Note Writing)
99
10- This project is designed to run with OpenClaw as the primary authoring engine.
11- Human users do not need to manually write notes in markdown files .
10+ The project is designed around OpenClaw as the primary authoring engine.
11+ In normal operation, notes are not manually drafted one by one; OpenClaw handles creation and maintenance through APIs .
1212
1313Install this skill in OpenClaw first:
1414
15- - OpenKnowForge Skill: ` https://github.com/Reuben-Sun/OpenKnowForge-Skill.git `
15+ - OpenKnowForge- Skill: ` https://github.com/Reuben-Sun/OpenKnowForge-Skill.git `
1616
17- Recommended operating model :
17+ Recommended workflow :
1818
19- 1 . Install ` OpenKnowForge-Skill ` in OpenClaw from the repository above .
20- 2 . Let OpenClaw create, edit, classify, and maintain notes through OpenKnowForge APIs .
21- 3 . Keep human input focused on review and curation instead of raw note drafting .
19+ 1 . Install ` OpenKnowForge-Skill ` in OpenClaw.
20+ 2 . Let OpenClaw call OpenKnowForge APIs for note creation, editing, classification, and maintenance .
21+ 3 . Keep human effort focused on review, correction, and knowledge governance .
2222
2323![ Home] ( assets/Home.png )
2424
25- ## Why This Project Matters
25+ ## Design Philosophy
2626
27- OpenKnowForge is not just another markdown notebook.
28- Its core value is turning knowledge management into an engineering system:
29-
30- - OpenClaw-native workflow: note creation can be fully delegated to OpenClaw with ` OpenKnowForge-Skill ` .
31- - Programmable knowledge operations: notes are managed via HTTP APIs, so scripts/agents can create and maintain content reliably.
32- - Git-level governance: every note change is committed, auditable, and easy to roll back.
33- - Publish-ready architecture: data is edited dynamically but published as static pages for speed and low ops cost.
34- - Structured knowledge schema: each note carries metadata (status, timestamps, tags, stats), enabling deterministic indexing and filtering.
35- - Team-friendly delivery: local development is lightweight, deployment is CI-driven, and output is accessible through GitHub Pages.
27+ - Automation first: treat note-taking as an orchestrated knowledge pipeline driven by APIs.
28+ - Traceability first: keep every content change in Git history for auditability and rollback.
29+ - Publishing first: combine dynamic ingestion with static delivery for both velocity and reliability.
30+ - Structure first: use a consistent metadata model to support indexing, search, sorting, and rendering.
31+ - Collaboration first: keep local setup lightweight and deployment CI-driven for team adoption.
3632
3733## Core Capabilities (Implemented)
3834
@@ -48,46 +44,46 @@ Its core value is turning knowledge management into an engineering system:
4844- Search notes: ` GET /notes/search `
4945- Push repository: ` POST /git/push `
5046
51- ### 2) Strong metadata model
47+ ### 2) Structured metadata model
5248
5349Each note maintains:
5450
55- - ` status ` : ` mature ` or ` draft `
56- - ` created_at ` , ` updated_at ` , ` submitted_at `
57- - ` tags ` , ` related ` , ` type `
58- - ` word_count ` , ` image_count `
51+ - Status: ` status ` ( ` mature ` / ` draft ` )
52+ - Time fields: ` created_at ` , ` updated_at ` , ` submitted_at `
53+ - Semantic fields: ` tags ` , ` related ` , ` type `
54+ - Statistics: ` word_count ` , ` image_count `
5955
60- This supports reliable sorting, filtering, and UI rendering .
56+ This model keeps sorting, filtering, rendering, and API responses consistent .
6157
62- ### 3) Reliable content stats
58+ ### 3) Automatic statistics and backfill
6359
64- Word/ image statistics are calculated when creating and editing notes .
65- Existing notes are also backfilled automatically on startup when needed .
60+ Word and image counts are computed on create and update .
61+ Legacy notes are backfilled when needed during startup to keep metadata consistent .
6662
67- ### 4) Image ingestion and normalization
63+ ### 4) Image ingestion and normalized storage
6864
69- The API accepts image inputs as:
65+ The API accepts image input as:
7066
7167- Data URL
7268- HTTP(S) URL
7369- Base64 string
7470
75- Images are stored under ` docs/project/images/ ` and linked into the note body .
71+ Images are stored under ` docs/project/images/ ` and injected into note content automatically .
7672
77- ### 5) Auto index and site sync
73+ ### 5) Auto index rebuild and site sync
7874
79- After note changes , the system automatically rebuilds:
75+ After note mutations , the system rebuilds:
8076
8177- Notes index pages
8278- English note alias files
8379- ` docs/public/search-index.json `
8480
85- So local docs preview and static site outputs stay in sync with the latest content.
81+ This keeps local preview and static output aligned with current content.
8682
8783### 6) Built-in Git traceability
8884
89- Note create/ update/ delete operations auto-stage and auto-commit content updates .
90- The API response includes commit hash/time when a commit is generated .
85+ Create, update, and delete operations perform automatic staging and committing .
86+ When a commit is created, the API response includes the commit hash and timestamp .
9187
9288## Architecture
9389
@@ -111,9 +107,9 @@ GitHub Pages
111107
112108- Backend API: FastAPI
113109- Content format: Markdown + YAML frontmatter
114- - Site generator : VitePress
115- - Index/search source: ` docs/public/search-index.json `
116- - CI/CD : GitHub Actions + GitHub Pages
110+ - Docs engine : VitePress
111+ - Search index source: ` docs/public/search-index.json `
112+ - Delivery pipeline : GitHub Actions + GitHub Pages
117113
118114## Quick Start
119115
@@ -145,20 +141,18 @@ npm run docs:dev
145141
146142## GitHub Pages Deployment
147143
148- This repository already contains workflow config at:
149-
150- - ` .github/workflows/pages.yml `
144+ The repository already includes workflow configuration at ` .github/workflows/pages.yml ` .
151145
152- Deploy steps:
146+ Deployment steps:
153147
154- 1 . In GitHub repo settings, enable Pages and choose ` GitHub Actions ` as source.
148+ 1 . Enable GitHub Pages in repository settings and select ` GitHub Actions ` as the source.
1551492 . Push commits to ` main ` .
156- 3 . The Pages workflow builds and publishes docs automatically.
150+ 3 . The workflow builds and publishes the site automatically.
157151
158152## Project Layout (High-level)
159153
160154- API code: ` api/ `
161- - UI/guide docs : ` docs/ui/ `
155+ - UI and guides : ` docs/ui/ `
162156- User notes: ` docs/project/entries/ `
163157- User images: ` docs/project/images/ `
164158- Search index: ` docs/public/search-index.json `
0 commit comments