Skip to content

项目目录说明

本文档说明当前项目的顶层目录职责。当前项目已拆分为知识库源内容、Web 展示系统、自动化脚本和项目规范四类内容。

顶层目录

text
core-bank/
├── README.md
├── apps/
├── wiki/
├── web/
├── scripts/
└── project-docs/

目录职责

目录职责维护原则
apps/内部应用层,统一收纳独立静态 app 与应用导航页。每个 app 自治构建,不和 wiki 正文混写。
wiki/知识库源内容,包含中文源、英文学习版、截图、图表和附件。所有业务知识只在这里维护。
web/Web 可视化系统代码。负责展示知识库,不作为业务知识源头。
scripts/项目级或 wiki 级自动化脚本。放同步、检查、索引和构建辅助脚本。
project-docs/项目运作规则、目录说明、架构设计、部署说明和阶段进展记录。放项目管理文档,不放业务正文。

为什么这样拆分

wiki/ 是核心资产,应该能独立阅读、迁移和备份。当前采用:

text
wiki/
├── cn/
└── en/

cn 是中文业务知识源头,en 是英文学习版,用于在保留中文源的同时沉淀美式银行业务表达。

web/ 是展示层,未来可以替换技术方案,不影响知识库正文。

apps/ 是应用层,承接不适合直接放进 Wiki 正文体系的独立 app,例如 GitHub 日报。

scripts/ 服务整个项目或 wiki 内容,不默认归属于 Web。

project-docs/ 保存规范和设计说明,避免和业务知识混在一起。

项目运作规则

项目日常运作以 项目运作规则.md 为准,核心原则是:

  • wiki/cn/ 是中文业务知识源头。
  • wiki/en/ 是英文学习版源头,与中文保持同路径结构。
  • web/wiki/web/project-docs/ 是同步生成内容,不手工维护;中文生成到 web/wiki/cn/,英文学习版生成到 web/wiki/en/
  • apps/ 负责承载独立静态应用;当前 gh-daily 通过 /apps/gh-daily/ 访问。
  • 新增或修改业务含义时,同步更新中文、英文和术语表。
  • 发布前必须运行 cd web && npm run checknpm run build
  • apps/ 的共享参数统一收敛到 apps/.env,CI 中也按同一套变量语义维护。
  • 提交到 GitHub 时按 GitHub提交SOP.md 执行。
  • 阶段性未完成事项可记录到对应进展文档,例如 贷款专题补充进展.md

后续工作流

text
新增截图或业务资料
-> 更新 wiki/cn/
-> 同步更新 wiki/en/
-> 检查 Markdown 链接和图片引用
-> Web 系统读取 wiki/
-> 构建并部署到服务器

当前 Web 系统已采用 VitePress 实现。部署前执行:

bash
cd web
npm run check
npm run build

当前正式发布已接入 GitHub Actions + Docker + GitOps,主站和 apps/ 会一起发布到 https://wiki.onetic.cc/;其中 gh-daily 额外有每日凌晨自动生成任务。