> For AI agents: the complete documentation index is available at /zh/llms.txt, the full documentation bundle is available at /zh/llms-full.txt.

# 参与与反馈

## 报告问题

在 GitHub 仓库提交 issue 时，附上下面的信息能显著缩短定位时间：

- 最小 wikitext 源码与 `pageName`。
- 使用的入口与关键选项（`parseOptions`、`prepareOptions`、`policy`、`labels`）。
- 库版本、`parserVersion`、React 与打包器版本。
- 完整错误对象的 `code`、`stage` 与 `cause`，以及 `document.diagnostics`。
- 期望输出与实际输出；如果涉及样式，附上屏幕截图或 DOM 片段。

请先确认问题不是[渲染行为](/zh/guide/rendering.md)或[支持矩阵](/zh/guide/syntax-support.md)中标注的行为。

## 运行文档站

文档使用 Rspress，源码位于 `website/`：

```bash
pnpm install
pnpm docs:dev     # 本地预览
pnpm docs:build   # 构建到 website/doc_build/
pnpm docs:preview # 预览构建产物
```

- 中文内容在 `website/docs/zh/`，英文在 `website/docs/en/`；新增页面时两边都要补齐。
- 目录结构由各目录的 `_meta.json` 与顶部的 `_nav.json` 决定。
- 指南中的可运行示例使用 ` ```tsx preview ` 代码块；示例通过包公共入口导入，由 `@rspress/plugin-preview` 渲染。
- 首页在线示例由 `website/theme/HomeExample.tsx` 在客户端按需加载库源码。

## 修改文档

- 行为、默认值与导出以 `src/` 与 `tests/` 为准；文档不复制容易漂移的完整测试清单或固定性能数字。
- 指南负责“怎么做”，参考负责“有什么”；同一个事实只写一处，其他页面链接过去。
- 代码片段应能独立理解；涉及安全边界时明确标注“可信代码”或“不可信输入”。
- 中英文段落保持一一对应，术语保持一致：解析快照、渲染快照、解析函数、策略、文案。

## 提交前检查

```bash
pnpm format:check
pnpm lint
pnpm typecheck
pnpm test
pnpm docs:build
```

改动构建、导出或依赖时再运行：

```bash
pnpm test:consumer
pnpm build
```

完整贡献流程、环境要求与 CI 说明见仓库根目录的 [`CONTRIBUTING.md`](https://github.com/BearBin1215/react-wikitext/blob/main/CONTRIBUTING.md)。

## 许可

提交内容按仓库的 GPL-3.0-or-later 许可分发；新增第三方代码或资源时，需要同步更新 `NOTICE` 与 `THIRD_PARTY_LICENSES`。