- forum-solved-export: 3539 个已解决话题(问题+全部对话+采纳回答),含索引 - rdk-docs-export: 21 个文档子站 ~3430 篇 Markdown(源码仓库/抓取/反解析三种方式) - kb-eval: 352 条 RAG 检索评测集(答案全部锚定文档、多轮子代理交叉审计), 含检索/出题/校验工具与子代理提示词模板,支持增量扩产 - pipeline: 论坛枚举导出、文档抓取反解析、覆盖率统计全部脚本(可重跑)
English | 简体中文
Documentation Repository
This repository contains the source code for the RDK S100 / S600 development documentation site, built with Docusaurus. It includes the main Chinese documentation, English translations, site theme customization, document scope filtering (Doc Scope), and an automated release process.
Environment Setup
- Node.js:
>= 18 - Package manager:
npm
# Quick installation for daily development (updates dependencies according to semver)
npm install
Common Maintenance Commands
Content and Structure Maintenance
# Generate sidebar scope configuration (Doc Scope)
npm run generate-sidebar-config
# Watch document changes during development and automatically update sidebar scope configuration
npm run watch-sidebar-config
Local Development
# Chinese development mode (includes sidebar config watching)
npm run start
# English development mode (includes sidebar config watching)
npm run start:en
# Chinese development mode, using port 3001
npm run start:port
# Chinese development mode (without starting watcher)
npm run start:no-watch
# English development mode (without starting watcher)
npm run start:no-watch:en
# Clear Docusaurus cache
npm run clear
Build and Output Verification
# Standard full build
npm run build
# Locally preview the build directory
npm run serve
# Preview with specified host and port (example)
npm run serve -- --host=10.64.62.34 --port=1688 --no-open
Common access paths (the port will depend on the actual serve output):
- English:
http://localhost:3000/en/rdk_s_doc/RDK - Chinese:
http://localhost:3000/rdk_s_doc/RDK