From c0c1ab0f511fc35a9151e3b4b2933a55292868e6 Mon Sep 17 00:00:00 2001 From: Wu Sheng Date: Sun, 18 Jan 2026 09:24:03 +0800 Subject: [PATCH] Polish docs/README.md and update CLAUDE.md PR guidelines --- CLAUDE.md | 1 + docs/README.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 599e4c49f38d..7f48ff5219d1 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -309,6 +309,7 @@ Follow the PR template in `.github/PULL_REQUEST_TEMPLATE`. Key requirements: **Always:** - Reference related issue: `Closes #` - Update [`CHANGES` log](https://github.com/apache/skywalking/blob/master/docs/en/changes/changes.md) +- Do NOT add AI assistant as co-author. Code responsibility is on the committer's hands. ## Tips for AI Assistants diff --git a/docs/README.md b/docs/README.md index f0fa70fe2f4b..8e63d627a0f2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,7 +14,7 @@ Installation and configuration guides for different deployment scenarios. - **Quick Start** - Get SkyWalking running with [Docker](en/setup/backend/backend-docker.md) or [Kubernetes](en/setup/backend/backend-k8s.md) - **Marketplace** - Explore all [out-of-box monitoring features](en/setup/backend/marketplace.md) for services, service mesh, Kubernetes, databases, message queues, and more -- **Agent Compatibility** - Check [supported libraries and frameworks](en/setup/service-agent/agent-compatibility.md) for SkyWalking language agents +- **Agent Compatibility** - Check [agent compatibility](en/setup/service-agent/agent-compatibility.md) for SkyWalking language agents - **Advanced Setup** - Storage options, cluster management, security, and dynamic configuration ### APIs @@ -27,7 +27,7 @@ Extend SkyWalking with custom analysis pipelines using [Observability Analysis L [Suggestions](en/security/README.md) for keeping your SkyWalking deployment secure. For reporting security vulnerabilities, please follow the [ASF Security Policy](https://www.apache.org/security/). ### Academy -In-depth [articles and papers](en/academy/scaling-with-apache-skywalking.md) about SkyWalking architecture and best practices. +In-depth articles and papers about SkyWalking architecture and best practices. ### FAQs [Solutions](en/FAQ/README.md) to common issues with setup and development.