diff --git a/.github/workflows/docs-link-check.yml b/.github/workflows/docs-link-check.yml new file mode 100644 index 000000000..2c412a944 --- /dev/null +++ b/.github/workflows/docs-link-check.yml @@ -0,0 +1,41 @@ +name: Docs link check + +on: + pull_request: + paths: + - README.md + - README_ZH.md + - pyproject.toml + - AGENTS.md + - .github/workflows/docs-link-check.yml + schedule: + # 每月 1 日 09:00(北京时间)例行巡检,及时发现文档站改版导致的失效链接 + - cron: '0 1 1 * *' + workflow_dispatch: + +permissions: + contents: read + +jobs: + link-check: + name: Check links in README and pyproject + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Run lychee + uses: lycheeverse/lychee-action@v2 + with: + # 动态徽章(shields.io)与 Discord 邀请链接会随外部服务波动,跳过以免误报; + # npmjs.com 与 x.com 对非浏览器/数据中心 IP 请求返回 403(反爬), + # API 端点需鉴权,均为误报来源 + args: >- + --verbose + --no-progress + --accept 200..299 + --exclude 'img.shields.io' + --exclude 'discord.gg' + --exclude 'www.npmjs.com' + --exclude 'x.com' + --exclude 'memos.memtensor.cn/api' + README.md README_ZH.md pyproject.toml AGENTS.md + fail: true diff --git a/AGENTS.md b/AGENTS.md index cd885b3c4..346c14d6b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -8,7 +8,7 @@ **MemOS / MemoryOS**: a memory operating system for LLM agents. Python library plus a FastAPI service, providing multiple memory types (textual / tree / preference / skill / KV cache / LoRA parametric) plus scheduling, version management, and vector & graph storage. - **Repository**: https://github.com/MemTensor/MemOS -- **Documentation**: https://memos-docs.openmem.net/home/overview/ +- **Documentation**: https://memos-docs.openmem.net/ - **PyPI**: https://pypi.org/project/MemoryOS/ - **License**: Apache-2.0 - **Top-level package**: `src/memos/`. Distribution name `MemoryOS`; import name `memos`. diff --git a/README.md b/README.md index 9c85150d0..1157cc197 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@
-
+
diff --git a/README_ZH.md b/README_ZH.md
index 25dc7775b..3113e6643 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -7,7 +7,7 @@
-
+
diff --git a/pyproject.toml b/pyproject.toml
index 314fce3d5..f97d83bab 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -57,7 +57,7 @@ repository = "https://github.com/MemTensor/MemOS"
download = "https://pypi.org/project/MemoryOS/#files"
changelog = "https://github.com/MemTensor/MemOS/releases"
releasenotes = "https://github.com/MemTensor/MemOS/releases"
-documentation = "https://memos-docs.openmem.net/home/overview/"
+documentation = "https://memos-docs.openmem.net/"
issues = "https://github.com/MemTensor/MemOS/issues"
[project.scripts]