Art Blocks 项目文档教程

Art Blocks 项目文档教程

artblocks-docs Art Blocks Docs, powered by Retype 项目地址: https://gitcode.com/gh_mirrors/ar/artblocks-docs

1. 项目的目录结构及介绍

Art Blocks 项目的目录结构如下：

artblocks-docs/
├── docs/
│   ├── art-blocks-101/
│   ├── art-blocks-api/
│   ├── art-blocks-engine-onboarding/
│   ├── core-contract-v3/
│   ├── creator-onboarding/
│   ├── minter-suite/
│   ├── public-api-docs/
│   └── static/
├── .gitignore
├── CODEOWNERS
├── LICENSE
├── README.md
├── favicon.ico
├── legacy.md
└── retype.yml

目录结构介绍

• docs/: 包含项目的核心文档，分为多个子目录，每个子目录对应不同的文档模块。

  • art-blocks-101/: 基础入门文档。
  • art-blocks-api/: API 相关文档。
  • art-blocks-engine-onboarding/: 引擎平台入门文档。
  • core-contract-v3/: 核心合约 v3 相关文档。
  • creator-onboarding/: 创作者入门文档。
  • minter-suite/: 铸造套件相关文档。
  • public-api-docs/: 公共 API 文档。
  • static/: 静态资源文件。

• .gitignore: Git 忽略文件配置。

• CODEOWNERS: 代码所有者配置文件。

• LICENSE: 项目许可证文件，采用 GPL-3.0 许可证。

• README.md: 项目介绍和使用说明。

• favicon.ico: 网站图标。

• legacy.md: 遗留文档。

• retype.yml: Retype 配置文件，用于生成文档网站。

2. 项目的启动文件介绍

Art Blocks 项目的启动文件主要是 retype.yml 文件。该文件是 Retype 的配置文件，用于生成和配置文档网站。

retype.yml 文件介绍

retype.yml 文件包含了文档网站的配置信息，如网站标题、导航菜单、页面布局等。以下是 retype.yml 文件的主要配置项：

title: Art Blocks Docs
url: https://docs.artblocks.io
description: 欢迎来到 Art Blocks 文档。

• title: 文档网站的标题。
• url: 文档网站的 URL。
• description: 文档网站的描述。

通过配置 retype.yml 文件，可以自定义文档网站的外观和功能，使其更符合项目的需求。

3. 项目的配置文件介绍

Art Blocks 项目的配置文件主要包括 retype.yml 和 CODEOWNERS 文件。

retype.yml 配置文件

retype.yml 文件是 Retype 的配置文件，用于生成和配置文档网站。该文件包含了文档网站的标题、URL、描述等信息。通过修改 retype.yml 文件，可以自定义文档网站的外观和功能。

CODEOWNERS 配置文件

CODEOWNERS 文件用于指定代码库中各个文件或目录的所有者。当有人提交更改时，所有者会收到通知。以下是 CODEOWNERS 文件的示例：

docs/ @artblocks/docs-team

• docs/: 指定 docs/ 目录的所有者。
• @artblocks/docs-team: 所有者的 GitHub 用户名或团队名。

通过配置 CODEOWNERS 文件，可以确保代码库中的每个部分都有明确的责任人，便于管理和维护。

artblocks-docs Art Blocks Docs, powered by Retype 项目地址: https://gitcode.com/gh_mirrors/ar/artblocks-docs