Skip to content

Commit a96e5ee

Browse files
committed
docs: rewrite README in formal style and rename philosophy section
1 parent a516c76 commit a96e5ee

2 files changed

Lines changed: 81 additions & 92 deletions

File tree

README.md

Lines changed: 40 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,33 @@
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

1313
Install 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

5349
Each 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.
155149
2. 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`

README.zh-CN.md

Lines changed: 41 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,33 @@
22

33
[English](README.md)
44

5-
OpenKnowForge 是一个 API 原生、Git 驱动的知识库系统
6-
它把笔记生产、元数据治理、静态发布、版本追踪整合成一条可工程化的工作流
5+
OpenKnowForge 是一套以 API 为核心、以 Git 为底座的知识工程系统
6+
它将内容生成、结构化治理、静态发布与版本审计整合为统一流程,用于构建可持续演进的知识库
77

8-
## OpenClaw 全自动工作流(无需人工写笔记)
8+
## OpenClaw First:无需人工撰写笔记
99

10-
这个项目的设计前提是以 OpenClaw 作为主要内容生产引擎
11-
日常使用中不需要人类手动维护 markdown 笔记正文
10+
本项目默认采用 OpenClaw 作为内容生产引擎
11+
在常规工作流中,笔记创建与维护并不依赖人工逐篇撰写,而是由 OpenClaw 通过 API 自动完成
1212

13-
请优先在 OpenClaw 中安装这个 Skill:
13+
请先在 OpenClaw 中安装以下 Skill:
1414

1515
- OpenKnowForge-Skill:`https://github.com/Reuben-Sun/OpenKnowForge-Skill.git`
1616

17-
推荐使用方式
17+
推荐流程如下
1818

19-
1. 在 OpenClaw 中从上述仓库安装 `OpenKnowForge-Skill`
20-
2. 由 OpenClaw 通过 OpenKnowForge API 完成笔记创建、编辑、分类和维护
21-
3. 人类主要负责复核与知识治理,而不是手工撰写原始笔记
19+
1. 在 OpenClaw 中安装 `OpenKnowForge-Skill`
20+
2. 由 OpenClaw 调用 OpenKnowForge API 完成新建、编辑、分类与维护
21+
3. 人类仅承担复核、校正与知识治理工作
2222

2323
![Home](assets/Home.png)
2424

25-
## 项目含金量
25+
## 设计哲学
2626

27-
OpenKnowForge 不是普通的 Markdown 笔记集合,它的价值在于把“记笔记”变成“可编排的知识工程”:
28-
29-
- OpenClaw 原生工作流:通过 `OpenKnowForge-Skill` 可将笔记创作全程交给 OpenClaw。
30-
- 可编程知识管理:通过 HTTP API 管理笔记,便于脚本与 Agent 自动化接入。
31-
- Git 级别治理:每次变更可追踪、可审计、可回滚,天然适配协作场景。
32-
- 生产可发布架构:写入是动态 API,输出是静态站点,兼顾开发效率与线上稳定性。
33-
- 结构化知识模型:每条笔记具备状态、时间戳、标签、统计信息,支持稳定检索与排序。
34-
- 团队可落地:本地启动轻量,部署通过 CI 自动化,最终站点可直接托管在 GitHub Pages。
27+
- 自动化优先:将“写笔记”升级为“知识工程流水线”,核心操作通过 API 可编排执行。
28+
- 可追溯优先:所有内容修改均进入 Git 历史,便于审计、对比与回滚。
29+
- 发布优先:动态写入、静态发布,兼顾内容更新效率与线上稳定性。
30+
- 结构化优先:以统一元数据驱动索引、检索、排序与展示。
31+
- 协作优先:本地环境轻量、CI 自动部署,适配个人与团队共建。
3532

3633
## 核心能力(已实现)
3734

@@ -44,49 +41,49 @@ OpenKnowForge 不是普通的 Markdown 笔记集合,它的价值在于把“
4441
- 删除笔记:`DELETE /note/{slug}`
4542
- 全量列表:`GET /notes`
4643
- 草稿列表:`GET /notes/drafts`
47-
- 笔记搜索`GET /notes/search`
44+
- 条件搜索`GET /notes/search`
4845
- 推送远端:`POST /git/push`
4946

50-
### 2) 强约束元数据模型
47+
### 2) 结构化元数据模型
5148

52-
每条笔记都维护
49+
每条笔记维护以下关键字段
5350

54-
- `status``mature`(成熟知识)或 `draft`(草稿
55-
- `created_at``updated_at``submitted_at`
56-
- `tags``related``type`
57-
- `word_count``image_count`
51+
- 状态:`status``mature` / `draft`
52+
- 时间:`created_at``updated_at``submitted_at`
53+
- 语义:`tags``related``type`
54+
- 统计:`word_count``image_count`
5855

59-
这些字段让排序、筛选、展示逻辑更稳定
56+
该模型保证排序、筛选、渲染与接口返回的一致性
6057

61-
### 3) 自动统计机制
58+
### 3) 统计自动计算与回填
6259

63-
在创建和编辑笔记时会自动统计字数与图片数量
64-
对历史笔记也会在需要时自动补齐统计,保证数据一致性
60+
系统在创建和编辑笔记时自动计算字数与图片数
61+
对于历史笔记,启动阶段会在需要时自动补齐统计字段,以维持数据一致
6562

66-
### 4) 图片写入能力
63+
### 4) 图片接入与规范化存储
6764

68-
API 支持以下图片输入格式
65+
API 支持以下图片输入形式
6966

7067
- Data URL
71-
- HTTP(S) 链接
68+
- HTTP(S) URL
7269
- Base64 字符串
7370

74-
图片落地到 `docs/project/images/`并自动写入笔记内容
71+
图片统一保存至 `docs/project/images/`并自动写入笔记正文
7572

76-
### 5) 索引与站点自动同步
73+
### 5) 索引自动重建与站点同步
7774

78-
每次笔记变更后会自动重建
75+
每次笔记变更后,系统会自动重建
7976

8077
- Notes 索引页
8178
- 英文笔记别名文件
8279
- `docs/public/search-index.json`
8380

84-
保证本地预览与静态构建结果始终和内容同步
81+
因此,本地预览与静态构建结果可与最新内容保持同步
8582

8683
### 6) 内建 Git 追踪
8784

88-
新增/编辑/删除笔记会自动执行暂存和提交
89-
接口返回中会带上 commit hash 与提交时间(当实际产生提交时)
85+
新增、编辑、删除操作会自动执行暂存与提交
86+
当实际产生提交时,API 返回中包含 commit hash 与提交时间。
9087

9188
## 架构链路
9289

@@ -110,9 +107,9 @@ GitHub Pages
110107

111108
- 后端 API:FastAPI
112109
- 内容格式:Markdown + YAML frontmatter
113-
- 文档站点:VitePress
114-
- 搜索索引`docs/public/search-index.json`
115-
- 持续部署:GitHub Actions + GitHub Pages
110+
- 文档引擎:VitePress
111+
- 检索索引`docs/public/search-index.json`
112+
- 发布链路:GitHub Actions + GitHub Pages
116113

117114
## 快速开始
118115

@@ -144,15 +141,13 @@ npm run docs:dev
144141

145142
## GitHub Pages 部署
146143

147-
仓库已包含工作流配置:
148-
149-
- `.github/workflows/pages.yml`
144+
仓库已包含工作流配置:`.github/workflows/pages.yml`
150145

151146
部署步骤:
152147

153148
1. 在 GitHub 仓库设置中启用 Pages,Source 选择 `GitHub Actions`
154149
2. 推送提交到 `main` 分支。
155-
3. 工作流会自动构建并发布文档站点
150+
3. 工作流自动构建并发布文档站点
156151

157152
## 项目结构(高层)
158153

0 commit comments

Comments
 (0)