Skip to content

Polish docs/README.md and update CLAUDE.md PR guidelines #13672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wu-sheng merged 1 commit into from
Jan 18, 2026
+3 −2
Merged

Polish docs/README.md and update CLAUDE.md PR guidelines #13672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,7 @@ Follow the PR template in `.github/PULL_REQUEST_TEMPLATE`. Key requirements:
**Always:**
- Reference related issue: `Closes #<issue number>`
- 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

Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Loading