diff --git a/README.md b/README.md index 0c7cb76f..1c909fc8 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ PyPI Downloads GitHub commit activity License + Documentation English 简体中文 GitHub Stars @@ -315,7 +316,7 @@ are mainly for maintenance, debugging, or advanced integration. Run `reme help` - **Issues and requests**: Check [Open Issues](https://github.com/agentscope-ai/ReMe/issues) first. If there is no related discussion, open a new issue with background, expected behavior, and impact scope. - **Code contributions**: Before making changes, read - the [contribution guide](https://docs.agentscope.io/reme/stable/en/contributing). Source, schemas, and tests are the + the [contribution guide](https://docs.agentscope.io/reme/latest/en/contribution). Source, schemas, and tests are the authoritative architecture and extension guide. - **Documentation contributions**: Submit user-facing documentation changes to the [unified documentation repository](https://github.com/agentscope-ai/docs) under `reme//{en,zh}/`. @@ -324,7 +325,7 @@ are mainly for maintenance, debugging, or advanced integration. Run `reme help` - **Pre-submit checks**: Before submitting a PR, try to run `pre-commit run --all-files` and `pytest`. If tests that depend on LLMs, embeddings, or external services cannot run, explain that in the PR. - **Get help**: Use [GitHub Issues](https://github.com/agentscope-ai/ReMe/issues) for bugs and feature requests. Project - documentation is available at [https://docs.agentscope.io/](https://docs.agentscope.io/reme/stable/en/). + documentation is available at [https://docs.agentscope.io/reme](https://docs.agentscope.io/reme). ### Contributors diff --git a/README_ZH.md b/README_ZH.md index 3c6f2378..79ecf6f3 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -8,6 +8,7 @@ PyPI Downloads GitHub commit activity License + 文档 English 简体中文 GitHub Stars @@ -301,7 +302,7 @@ frontmatter 和文件操作接口主要用于维护、调试或高级集成。 - **问题反馈与需求**:请先查看 [Open Issues](https://github.com/agentscope-ai/ReMe/issues);如无相关讨论,可新建 Issue 说明背景、目标行为和影响范围。 -- **代码贡献**:改动前建议阅读 [贡献指南](https://docs.agentscope.io/reme/stable/zh/contributing)。架构与扩展方式以源码、schema +- **代码贡献**:改动前建议阅读 [贡献指南](https://docs.agentscope.io/reme/latest/zh/contribution)。架构与扩展方式以源码、schema 和测试为准。 - **文档贡献**:用户可见文档请提交到[统一文档仓库](https://github.com/agentscope-ai/docs)的 `reme//{en,zh}/` 目录。 - **提交规范**:建议使用 Conventional Commits,例如 `feat(search): add link expansion option`、 @@ -309,7 +310,7 @@ frontmatter 和文件操作接口主要用于维护、调试或高级集成。 - **提交前检查**:提交 PR 前请尽量运行 `pre-commit run --all-files` 和 `pytest`;如有依赖 LLM、embedding 或外部服务的测试无法运行,请在 PR 中说明。 - **获取帮助**:如需反馈 Bug 或功能请求,请使用 [GitHub Issues](https://github.com/agentscope-ai/ReMe/issues);项目文档见 - [https://docs.agentscope.io/](https://docs.agentscope.io/reme/stable/zh/)。 + [https://docs.agentscope.io/reme](https://docs.agentscope.io/reme)。 ### 贡献者