Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,7 @@ $ISNAD applies this ancient wisdom to code provenance.
---

*Built by [Rapi](https://github.com/0xRapi) ⚡*

## Translations

- [简体中文 / Simplified Chinese documentation](./docs/zh-CN/README.md)
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,7 @@ Visit https://isnad.md/check
- **API:** https://api.isnad.md
- **GitHub:** https://github.com/counterspec/isnad
- **Twitter:** https://x.com/isnad_protocol

## Translations

- [简体中文 / Simplified Chinese](./zh-CN/README.md)
17 changes: 17 additions & 0 deletions docs/zh-CN/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# ISNAD 中文文档

本目录提供 ISNAD 核心文档的简体中文版本,帮助中文读者快速了解项目目标、核心概念、快速开始流程和扫描器 CLI 使用方式。

## 文档索引

- ISNAD 简介:what-is-isnad.md
- 快速开始:getting-started.md
- 扫描器 CLI 使用指南:scanner-cli.md

## 关于 ISNAD

ISNAD 是一个面向技能、贡献与可信证明的协议和工具集。它帮助用户记录、验证和展示与技能或贡献相关的证明,并为项目方、审计者和社区成员提供更清晰的验证流程。

## 翻译说明

本次提交聚焦 issue #4 要求的核心中文文档:README、快速开始指南和扫描器 CLI 文档。建议由中文母语或流利中文审阅者在合并前进行最终校对。
29 changes: 29 additions & 0 deletions docs/zh-CN/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 快速开始

本指南帮助中文用户快速浏览 ISNAD 项目并开始使用核心文档和扫描器。

## 1. 克隆仓库

运行 git clone,然后进入 isnad 目录。

## 2. 阅读核心文档

建议先阅读 README.md、docs/README.md、docs/what-is-isnad.md、docs/how-to-attest.md 和 scanner/README.md。

中文文档入口位于 docs/zh-CN/README.md。

## 3. 查看扫描器目录

扫描器代码位于 scanner/。进入该目录后,可以查看 package.json 了解可用命令。

## 4. 安装依赖

在 scanner/ 目录中运行 npm install。若需要严格按照 lockfile 安装,可以运行 npm ci。

## 5. 运行与验证

实际命令以 scanner/package.json 中的 scripts 字段为准。常见流程包括构建、启动和测试。

## 注意事项

本次提交仅新增中文文档,不修改合约、扫描器逻辑或生产代码。
31 changes: 31 additions & 0 deletions docs/zh-CN/scanner-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 扫描器 CLI 使用指南

本文档提供 ISNAD 扫描器命令行工具的中文说明。扫描器相关代码位于 scanner/ 目录。

## 目录位置

scanner/ 目录通常包含 README.md、package.json、src/ 和 tsconfig.json。

## 安装依赖

进入 scanner/ 目录后运行 npm install。若项目 lockfile 已固定依赖,可以运行 npm ci。

## 查看可用命令

扫描器的实际命令以 scanner/package.json 中的 scripts 字段为准。

## 构建扫描器

如果项目提供构建脚本,可以运行 npm run build。

## 运行扫描器

如果项目提供启动脚本,可以运行 npm run start 或 npm run dev。具体命令以当前 package.json 为准。

## 开发与调试

常见源码文件包括 src/index.ts、src/cli.ts、src/analyzer.ts、src/patterns.ts、src/service.ts 和 src/oracle.ts。

## 测试与验证

本次中文文档提交不修改扫描器代码。建议维护者在合并前确认文档链接正确,并在项目支持时运行构建或测试命令。
17 changes: 17 additions & 0 deletions docs/zh-CN/what-is-isnad.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 什么是 ISNAD?

ISNAD 是围绕可信技能证明和贡献验证构建的协议与应用生态。它的目标是让用户能够证明自己的能力、贡献记录或完成情况,并让审计者、项目方和社区成员更容易验证这些证明。

## 核心概念

证明:对某项技能、贡献或声明的可验证记录。

注册表:用于记录和查询证明相关信息。

审计者:负责检查提交内容是否真实、完整并符合规则。

质押:用于对参与者行为形成约束,提高系统可信度。

## 项目组成

仓库包含文档、扫描器、智能合约、网页应用、接口内容和设计参考。