This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git
The following commit(s) were added to refs/heads/master by this push:
new 685ada3921 Improve documentation structure and navigation (#13670)
685ada3921 is described below
commit 685ada392167fdc8a0b26d7ff97ff65d03eca8c8
Author: 吴晟 Wu Sheng <[email protected]>
AuthorDate: Fri Jan 16 14:58:42 2026 +0800
Improve documentation structure and navigation (#13670)
- Restructure docs/README.md for better high-level navigation
- Move Marketplace as top-level menu section with Overview introduction
- Polish marketplace.md as overview page for out-of-box monitoring features
- Add "What's Next" section to Quick Start docs guiding users to Marketplace
- Restructure agent compatibility page with OAP 10.x focus and clearer
format
- Add PR submission guidelines to CLAUDE.md
- Remove FAQ docs: v3-version-upgrade.md, v6-version-upgrade.md,
Hour-Day-Metrics-Stopping.md
- Remove "since 7/8/9.x" statements from setup docs (features are standard
in 10.x)
- Update FAQ README.md to remove references to deleted files
---
CLAUDE.md | 48 +++++++++++++++--
docs/README.md | 53 ++++++++++++++-----
docs/en/FAQ/Hour-Day-Metrics-Stopping.md | 8 ---
docs/en/FAQ/README.md | 3 --
docs/en/FAQ/v3-version-upgrade.md | 11 ----
docs/en/FAQ/v6-version-upgrade.md | 29 -----------
docs/en/changes/changes.md | 7 +++
docs/en/setup/backend/backend-cluster.md | 3 +-
docs/en/setup/backend/backend-docker.md | 3 ++
docs/en/setup/backend/backend-k8s.md | 3 ++
docs/en/setup/backend/backend-setup.md | 3 ++
docs/en/setup/backend/dynamic-config-etcd.md | 2 +-
docs/en/setup/backend/grpc-security.md | 4 +-
docs/en/setup/backend/marketplace.md | 37 ++++++++++---
docs/en/setup/backend/mq.md | 4 +-
docs/en/setup/backend/service-auto-grouping.md | 2 +-
docs/en/setup/backend/ui-grafana.md | 2 +-
docs/en/setup/service-agent/agent-compatibility.md | 60 ++++++++++++++--------
docs/en/setup/service-agent/browser-agent.md | 2 +-
docs/menu.yml | 4 +-
20 files changed, 181 insertions(+), 107 deletions(-)
diff --git a/CLAUDE.md b/CLAUDE.md
index 7ccc0dab15..599e4c49f3 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -260,14 +260,56 @@ Always use `--recurse-submodules` when cloning or update
submodules manually.
- `lal/` - Log processing rules
- `log-mal-rules/` - Metrics extracted from logs
-## Important Links
+## Documentation (in `docs/en/`, structure defined in `docs/menu.yml`)
+
+- `concepts-and-designs/` - Architecture and core concepts (OAL, MAL, LAL,
profiling)
+- `setup/` - Installation and configuration guides
+- `api/` - Telemetry and query protocol documentation
+- `guides/` - Contributing guides, build instructions, testing
+- `changes/changes.md` - Changelog (update when making changes)
+- `swip/` - SkyWalking Improvement Proposals
+
+## Community
-- Documentation: `docs/en/` folder (source for all published docs, structure
defined in `docs/menu.yml`)
-- Change Logs: `docs/en/changes/changes.md` (update this file when making
changes)
- GitHub Issues: https://github.com/apache/skywalking/issues
- Mailing List: [email protected]
- Slack: #skywalking channel at Apache Slack
+## Submitting Pull Requests
+
+### Branch Strategy
+- **Never work directly on master branch**
+- Create a new branch for your changes: `git checkout -b
feature/your-feature-name` or `git checkout -b fix/your-fix-name`
+- Keep branch names descriptive and concise
+
+### PR Title
+Summarize the changes in the PR title. Examples:
+- `Fix BanyanDB query timeout issue`
+- `Add support for OpenTelemetry metrics`
+- `Improve documentation structure`
+
+### PR Description
+Follow the PR template in `.github/PULL_REQUEST_TEMPLATE`. Key requirements:
+
+**For Bug Fixes:**
+- Add unit test to verify the fix
+- Explain briefly why the bug exists and how to fix it
+
+**For New Features:**
+- Link to design doc if non-trivial
+- Update documentation
+- Add tests (UT, IT, E2E)
+- Attach screenshots if UI related
+
+**For Performance Improvements:**
+- Add benchmark for the improvement
+- Include benchmark results
+- Link to theory proof or discussion articles
+
+**Always:**
+- Reference related issue: `Closes #<issue number>`
+- Update [`CHANGES`
log](https://github.com/apache/skywalking/blob/master/docs/en/changes/changes.md)
+
## Tips for AI Assistants
1. **Always check submodules**: Protocol changes may require submodule updates
diff --git a/docs/README.md b/docs/README.md
index 8c13e4d2bd..f0fa70fe2f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,28 +2,53 @@
**This is the official documentation of SkyWalking 10. Welcome to the
SkyWalking community!**
-Here you can learn all you need to know about **SkyWalking**'s architecture,
understand how to deploy and use SkyWalking, and contribute to the project
based on SkyWalking's contributing guidelines.
+SkyWalking is an open source observability platform for collecting, analyzing,
aggregating, and visualizing data from services and cloud native
infrastructures. It provides distributed tracing, service mesh telemetry
analysis, metrics aggregation, alerting, and visualization capabilities.
-- **Concepts and Designs**. You'll find the core logic behind SkyWalking. You
may start from here if you want to
- understand what is going on under our cool features and visualization.
+## Documentation Structure
-- **Setup**. A guide to install SkyWalking for different use cases. It is an
observability platform that supports multiple observability modes.
+### Concepts and Designs
+Understand the core architecture, terminology, and design principles of
SkyWalking. Start with the [Overview](en/concepts-and-designs/overview.md).
-- **Contributing Guides**. If you are a PMC member, a committer, or a new
contributor, learn how to start contributing with these guides!
+### Setup
+Installation and configuration guides for different deployment scenarios.
-- **Protocols**. The protocols show how agents/probes and the backend
communicate with one another. Anyone interested in uplinking telemetry data
should definitely read this.
+- **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
+- **Advanced Setup** - Storage options, cluster management, security, and
dynamic configuration
-- **FAQs**. A manifest of known issues with setup and secondary developments
processes. Should you encounter any problems, check here first.
+### APIs
+Protocol specifications for integration, including [Telemetry
APIs](en/api/trace-data-protocol-v3.md) for reporting data and [Query
APIs](en/api/query-protocol.md) for retrieving data.
-You might also find these links interesting:
+### Customization
+Extend SkyWalking with custom analysis pipelines using [Observability Analysis
Language](en/concepts-and-designs/oal.md), [Meter Analysis
Language](en/concepts-and-designs/mal.md), and [Log Analysis
Language](en/concepts-and-designs/lal.md).
-- The latest and old releases are all available
- at [Apache SkyWalking release
page](https://skywalking.apache.org/downloads/). The change logs can be
- found [here](https://github.com/apache/skywalking/tree/master/changes).
+### Security
+[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/).
-- [SkyWalking
WIKI](https://cwiki.apache.org/confluence/display/SKYWALKING/Home) hosts the
context of some changes and events.
+### Academy
+In-depth [articles and papers](en/academy/scaling-with-apache-skywalking.md)
about SkyWalking architecture and best practices.
-- You can find the conference schedules, video recordings, and articles about
SkyWalking in the [community resource
catalog](https://github.com/OpenSkywalking/Community).
+### FAQs
+[Solutions](en/FAQ/README.md) to common issues with setup and development.
-We're always looking for help to improve our documentation and codes, so
please don’t hesitate to [file an
issue](https://github.com/apache/skywalking/issues/new) if you see any
problems. Or better yet, directly contribute by submitting a pull request to
help us get better!
+### Contributing Guides
+For contributors and committers - [contact the
community](en/guides/community.md), learn how to
[build](en/guides/How-to-build.md) and [test](en/guides/e2e.md) the project.
For major features, see [SkyWalking Improvement Proposals](en/swip/readme.md).
+### Changelog
+Release notes and version history. See [current
version](en/changes/changes.md) or browse all versions in the documentation
menu.
+
+## Additional Resources
+
+- [Apache SkyWalking Downloads](https://skywalking.apache.org/downloads/) -
Official releases
+- [SkyWalking
WIKI](https://cwiki.apache.org/confluence/display/SKYWALKING/Home) - Additional
context and events
+- [Community Resources](https://github.com/OpenSkywalking/Community) -
Conference schedules, videos, and articles
+- [SkyWalking CLI](https://github.com/apache/skywalking-cli) - Command line
interface
+
+## Getting Help
+
+- **Questions & Answers** - Post to [GitHub
Discussions](https://github.com/apache/skywalking/discussions)
+- **Bug Reports** - File an
[issue](https://github.com/apache/skywalking/issues/new) directly if you're
certain it's a bug
+- **Slack Channels** - Join `#skywalking` for English or `#skywalking-cn` for
Chinese discussions. To get an invite, send a request to
[email protected]
+
+We're always looking for help to improve our documentation and code. Feel free
to contribute by submitting a pull request!
diff --git a/docs/en/FAQ/Hour-Day-Metrics-Stopping.md
b/docs/en/FAQ/Hour-Day-Metrics-Stopping.md
deleted file mode 100644
index c6dcbffc24..0000000000
--- a/docs/en/FAQ/Hour-Day-Metrics-Stopping.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# Why do metrics indexes with Hour and Day precisions stop updating after
upgrade to 7.x?
-
-This issue is to be expected with an upgrade from 6.x to 7.x.
-See the [Downsampling Data Packing
feature](../setup/backend/backend-storage.md#downsampling-data-packing)
-of the ElasticSearch storage.
-
-You may simply delete all expired `*-day_xxxxx` and `*-hour_xxxxx`(`xxxxx` is
a timestamp) indexes.
-Currently, SkyWalking uses the `metrics name-xxxxx` and `metrics
name-month_xxxxx` indexes only.
diff --git a/docs/en/FAQ/README.md b/docs/en/FAQ/README.md
index 09329589f2..ef4ada4501 100644
--- a/docs/en/FAQ/README.md
+++ b/docs/en/FAQ/README.md
@@ -16,11 +16,8 @@ These are known and frequently asked questions about
SkyWalking. We welcome you
* [Version 9.x+ upgrade](v9-version-upgrade.md)
* [Elasticsearch exception `type=version_conflict_engine_exception` since
8.7.0](es-version-conflict.md)
* [Version 8.x+ upgrade](v8-version-upgrade.md)
-* [Why do metrics indexes with Hour and Day precisions stop updating after
upgrade to 7.x?](Hour-Day-Metrics-Stopping.md)
-* [Version 6.x upgrade](v6-version-upgrade.md)
* [Why are there only traces in UI?](Why-have-traces-no-others.md)
* [Tracing doesn't work on the Kafka consumer end](kafka-plugin.md)
-* [Agent or collector version upgrade, 3.x ->
5.0.0-alpha](v3-version-upgrade.md)
* [EnhanceRequireObjectCache class cast
exception](EnhanceRequireObjectCache-Cast-Exception.md)
* [ElasticSearch server performance issues, including ERROR
CODE:429](ES-Server-FAQ.md)
* [IllegalStateException when installing Java agent on WebSphere
7](install_agent_on_websphere.md)
diff --git a/docs/en/FAQ/v3-version-upgrade.md
b/docs/en/FAQ/v3-version-upgrade.md
deleted file mode 100644
index 84646bfa79..0000000000
--- a/docs/en/FAQ/v3-version-upgrade.md
+++ /dev/null
@@ -1,11 +0,0 @@
-## Version 3.x -> 5.0.0-alpha Upgrade FAQs
-### Collector
-### Problem
-There is no information showing in the UI.
-
-### Cause
-In the upgrade from version 3.2.6 to 5.0.0, the existing Elasticsearch indexes
are kept, but aren't compatible with 5.0.0-alpha.
-When service name is registered, ElasticSearch will create this column by
default type string, which will lead to an error.
-
-### Solution
-Clean the data folder in ElasticSearch and restart ElasticSearch, collector
and your application under monitoring.
diff --git a/docs/en/FAQ/v6-version-upgrade.md
b/docs/en/FAQ/v6-version-upgrade.md
deleted file mode 100644
index a6730f174a..0000000000
--- a/docs/en/FAQ/v6-version-upgrade.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# V6 upgrade
-SkyWalking v6 is widely used in many production environments. Follow the steps
in the guide below to learn how to upgrade to a new release.
-
-**NOTE**: The ways to upgrade are not limited to the steps below.
-
-## Use Canary Release
-Like all applications, you may upgrade SkyWalking using the `canary release`
method through the following steps.
-1. Deploy a new cluster by using the latest version of SkyWalking OAP cluster
with the new database cluster.
-2. Once the target service (i.e. the service being monitored) has upgraded the
agent.jar (or simply by rebooting), have `collector.backend_service`
-pointing to the new OAP backend, and use/add a new namespace(`agent.namespace`
in
-[Table of Agent Configuration
Properties](https://github.com/apache/skywalking-java/blob/20fb8c81b3da76ba6628d34c12d23d3d45c973ef/docs/en/setup/service-agent/java-agent/README.md#table-of-agent-configuration-properties)).
-The namespace will prevent conflicts from arising between different versions.
-3. When all target services have been rebooted, the old OAP clusters could be
discarded.
-
-The `Canary Release` method works for any version upgrades.
-
-## Online Hot Reboot Upgrade
-The reason we require `Canary Release` is that the SkyWalking agent has cache
mechanisms, and switching to a new cluster causes the
-cache to become unavailable for new OAP clusters.
-In version 6.5.0+ (especially for agent versions), we have [**Agent hot reboot
trigger
mechanism**](../setup/backend/backend-setup.md#agent-hot-reboot-trigger-mechanism-in-oap-server-upgrade).
-This streamlines the upgrade process as we **deploy a new cluster by using the
latest version of SkyWalking OAP cluster with the new database cluster**,
-and shift the traffic to the new cluster once and for all. Based on the
mechanism, all agents will enter the `cool_down` mode, and come
-back online. For more details, see the backend setup documentation.
-
-**NOTE**: A known bug in 6.4.0 is that its agent may have re-connection
issues; therefore, even though this bot reboot mechanism has been included in
6.4.0, it may not work under some network scenarios, especially in Kubernetes.
-
-## Agent Compatibility
-All versions of SkyWalking 6.x (and even 7.x) are compatible with each other,
so users could simply upgrade the OAP servers.
-As the agent has also been enhanced in the latest versions, according to the
SkyWalking team's recommendation, upgrade the agent as soon as practicable.
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index b8db97022b..b8b3b52049 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -35,6 +35,13 @@
* Add benchmark selection into banyanDB storage documentation.
* Fix progressive TTL doc for banyanDB.
+* Restructure `docs/README.md` for better navigation with high-level
documentation overview.
+* Move Marketplace as a top-level menu section with Overview introduction in
`menu.yml`.
+* Polish `marketplace.md` as the overview page for all out-of-box monitoring
features.
+* Add "What's Next" section to Quick Start docs guiding users to Marketplace.
+* Restructure agent compatibility page with OAP 10.x focus and clearer format
for legacy versions.
+* Remove outdated FAQ docs (v3, v6 upgrade guides and 7.x metrics issue).
+* Remove "since 7/8/9.x" version statements from documentation as features are
standard in 10.x.
All issues and pull requests are
[here](https://github.com/apache/skywalking/issues?q=milestone:10.4.0)
diff --git a/docs/en/setup/backend/backend-cluster.md
b/docs/en/setup/backend/backend-cluster.md
index f5db853620..0a43546830 100644
--- a/docs/en/setup/backend/backend-cluster.md
+++ b/docs/en/setup/backend/backend-cluster.md
@@ -159,8 +159,7 @@ The following settings are provided to set the host and
port manually, based on
## Etcd
-Set the **cluster/selector** to **etcd** in the yml to enable it. The Etcd
client has upgraded to v3 protocol and
-changed to the CoreOS official library. **Since 8.7.0, only the v3 protocol is
supported for Etcd.**
+Set the **cluster/selector** to **etcd** in the yml to enable it. The Etcd
client uses v3 protocol with the CoreOS official library. **Only the v3
protocol is supported for Etcd.**
```yaml
cluster:
diff --git a/docs/en/setup/backend/backend-docker.md
b/docs/en/setup/backend/backend-docker.md
index 230daa01c2..99ed419093 100644
--- a/docs/en/setup/backend/backend-docker.md
+++ b/docs/en/setup/backend/backend-docker.md
@@ -48,3 +48,6 @@ The files with the same name will be overridden; otherwise,
they will be added t
If you want to add more libs/jars into the classpath of OAP, for example, new
metrics for OAL. These jars can be mounted into `/skywalking/ext-libs`, then
`entrypoint` bash will append them into the classpath. Notice, you can't
override an existing jar in classpath.
+
+# What's Next
+After setting up SkyWalking with Docker, explore the
[Marketplace](marketplace.md) to discover all available monitoring features,
including language agents, service mesh observability, infrastructure
monitoring, and more.
diff --git a/docs/en/setup/backend/backend-k8s.md
b/docs/en/setup/backend/backend-k8s.md
index a030f5add3..0c1e21a72d 100644
--- a/docs/en/setup/backend/backend-k8s.md
+++ b/docs/en/setup/backend/backend-k8s.md
@@ -7,3 +7,6 @@ Follow instructions in the [deploying SkyWalking backend to
Kubernetes cluster](
to deploy OAP and UI to a Kubernetes cluster.
Please refer to the Readme file.
+
+## What's Next
+After deploying SkyWalking to Kubernetes, explore the
[Marketplace](marketplace.md) to discover all available monitoring features,
including language agents, service mesh observability, infrastructure
monitoring, and more.
diff --git a/docs/en/setup/backend/backend-setup.md
b/docs/en/setup/backend/backend-setup.md
index 38198e03f5..587b7ded1a 100755
--- a/docs/en/setup/backend/backend-setup.md
+++ b/docs/en/setup/backend/backend-setup.md
@@ -180,3 +180,6 @@ For example, metrics time will be formatted like
yyyyMMddHHmm in minute dimensio
By default, SkyWalking's OAP backend chooses the **OS default timezone**.
Please follow the Java and OS documents if you want to override the timezone.
+## What's Next
+After setting up the backend, explore the [Marketplace](marketplace.md) to
discover all available monitoring features, including language agents, service
mesh observability, infrastructure monitoring, and more.
+
diff --git a/docs/en/setup/backend/dynamic-config-etcd.md
b/docs/en/setup/backend/dynamic-config-etcd.md
index 7ff8ea207d..9c2d075bf4 100755
--- a/docs/en/setup/backend/dynamic-config-etcd.md
+++ b/docs/en/setup/backend/dynamic-config-etcd.md
@@ -14,7 +14,7 @@ configuration:
password: ${SW_CONFIG_ETCD_password:}
```
-**NOTE**: Since 8.7.0, only the v3 protocol is supported.
+**NOTE**: Only the v3 protocol is supported.
## Config Storage
### Single Config
diff --git a/docs/en/setup/backend/grpc-security.md
b/docs/en/setup/backend/grpc-security.md
index d5dae19845..e0f7f52550 100644
--- a/docs/en/setup/backend/grpc-security.md
+++ b/docs/en/setup/backend/grpc-security.md
@@ -1,6 +1,6 @@
# gRPC SSL transportation support for OAP server
-For OAP communication, we are currently using gRPC, a multi-platform RPC
framework that uses protocol buffers for message serialization. The nice part
about gRPC is that it promotes the use of SSL/TLS to authenticate and encrypt
exchanges. Now OAP supports enabling SSL transportation for gRPC receivers.
Since 8.8.0, OAP supports enabling mutual TLS authentication between probes and
OAP servers.
+For OAP communication, we are currently using gRPC, a multi-platform RPC
framework that uses protocol buffers for message serialization. The nice part
about gRPC is that it promotes the use of SSL/TLS to authenticate and encrypt
exchanges. OAP supports enabling SSL transportation for gRPC receivers and
mutual TLS authentication between probes and OAP servers.
To enable this feature, follow the steps below.
@@ -68,7 +68,7 @@ Since `receiver-sharing-server` only receives data from an
external source, it d
### Enable mTLS mode on gRPC receiver
-Since 8.8.0, SkyWalking has supported mutual TLS authentication for
transporting between clients and OAP servers. Enable `mTLS` mode for the gRPC
channel requires [Sharing gRPC Server](backend-expose.md) enabled, as the
following configuration.
+SkyWalking supports mutual TLS authentication for transporting between clients
and OAP servers. Enabling `mTLS` mode for the gRPC channel requires [Sharing
gRPC Server](backend-expose.md) enabled, as the following configuration.
```yaml
receiver-sharing-server:
diff --git a/docs/en/setup/backend/marketplace.md
b/docs/en/setup/backend/marketplace.md
index 7a398b3397..874ff29b81 100644
--- a/docs/en/setup/backend/marketplace.md
+++ b/docs/en/setup/backend/marketplace.md
@@ -1,12 +1,35 @@
# Marketplace
-**Marketplace** is the first UI menu on the SkyWalking native UI.
+The **Marketplace** provides an overview of all out-of-box monitoring features
available in SkyWalking. It is also the first UI menu on the SkyWalking native
UI.
-The native out-of-box features are listed in the marketplace. Follow the
`Documentation` guidance to set up the required components.
-Once SkyWalking detects the services of those layers, the relative menu will
show up on the left automatically.
+## Out-of-Box Monitoring Features
-If you prefer to have a custom dashboard to visualize your metrics, logs, and
traces in your private setup, you need to
-1. Follow Tracing, Logging, and Metrics documentation to set up codes.
-2. Follow Customization documentation to add analysis pipeline.
-3. Follow [UI Customization Setup documentation](../../ui/README.md) to set up
new UI dashboards.
+SkyWalking provides ready-to-use monitoring capabilities for a wide range of
technologies and platforms:
+
+- **General Services** - Application monitoring with language agents (Java,
Python, Go, Node.js, PHP, .NET, etc.), including tracing, metrics, and profiling
+- **Service Mesh** - Observability for Istio and Envoy-based service meshes
through Access Log Service (ALS) or metrics
+- **Kubernetes** - Cluster monitoring, pod metrics, and network profiling
+- **Infrastructure** - Linux and Windows server monitoring
+- **Cloud Services** - AWS EKS, S3, DynamoDB, API Gateway, and more
+- **Gateways** - Nginx, APISIX, Kong monitoring
+- **Databases** - MySQL, PostgreSQL, Redis, Elasticsearch, MongoDB,
ClickHouse, and more
+- **Message Queues** - Kafka, RabbitMQ, Pulsar, RocketMQ, ActiveMQ
+- **Browser** - Real user monitoring for web applications
+- **Self Observability** - Monitor SkyWalking OAP, Satellite, and agents
themselves
+
+## How It Works
+
+1. Browse the Marketplace sections in this documentation to find your target
technology
+2. Follow the setup guide to configure the required agents, receivers, or
integrations
+3. Once SkyWalking detects services of the configured type, the corresponding
menu and dashboards will appear automatically in the UI
+
+Each monitoring feature comes with pre-built dashboards, metrics, and alerting
capabilities.
+
+## Advanced: Custom Dashboards
+
+For users who need to visualize custom metrics or create specialized
dashboards beyond the out-of-box features:
+
+1. Set up data collection following the Tracing, Logging, or Metrics
documentation
+2. Configure custom analysis pipelines using the Customization documentation
+3. Create custom UI dashboards following the [UI Customization
documentation](../../ui/README.md)
diff --git a/docs/en/setup/backend/mq.md b/docs/en/setup/backend/mq.md
index 553835979b..078d8fbb45 100644
--- a/docs/en/setup/backend/mq.md
+++ b/docs/en/setup/backend/mq.md
@@ -4,9 +4,9 @@ Message Queue server plays an essential role in today's
distributed system to re
blocking RPC and eventually improve user experience. But in this async way,
the measure for queue consuming traffic and
latency becomes significant.
-Since 8.9.0, SkyWalking leverages native tracing agent and [**Extension Header
+SkyWalking leverages native tracing agent and [**Extension Header
Item** of SkyWalking Cross Process Propagation Headers Protocol
v3](../../api/x-process-propagation-headers-v3.md#extension-header-item)
-To provide performance monitoring for the Message Queue systems.
+to provide performance monitoring for the Message Queue systems.
In default, we provide `Message Queue Consuming Count` and `Message Queue Avg
Consuming Latency` metrics for service and
endpoint levels.
diff --git a/docs/en/setup/backend/service-auto-grouping.md
b/docs/en/setup/backend/service-auto-grouping.md
index a0d493f82c..46b531b2ac 100644
--- a/docs/en/setup/backend/service-auto-grouping.md
+++ b/docs/en/setup/backend/service-auto-grouping.md
@@ -4,7 +4,7 @@ Each template provides an appropriate layout for services in a
particular field.
For example, the metrics for services with language agents installed
may be different from that of services detected by the service mesh
observability solution as well as SkyWalking's self-observability metrics
dashboard.
-Therefore, since version 8.3.0, the SkyWalking OAP has generated the groups
based on this simple naming format:
+The SkyWalking OAP generates the groups based on this simple naming format:
### ${service name} = [${group name}::]${logic name}
diff --git a/docs/en/setup/backend/ui-grafana.md
b/docs/en/setup/backend/ui-grafana.md
index 45392ea074..3be7c8fe3e 100644
--- a/docs/en/setup/backend/ui-grafana.md
+++ b/docs/en/setup/backend/ui-grafana.md
@@ -1,5 +1,5 @@
# Use Grafana As The UI
-SkyWalking provide [PromQL Service](../../api/promql-service.md) since 9.4.0
and [LogQL Service](../../api/logql-service.md) since 9.6.0. You can choose
[Grafana](https://grafana.com/)
+SkyWalking provides [PromQL Service](../../api/promql-service.md) and [LogQL
Service](../../api/logql-service.md). You can choose
[Grafana](https://grafana.com/)
as the SkyWalking UI. About the installation and how to use please refer to
the [official document](https://grafana.com/docs/grafana/v9.3/).
Notice <1>, Gafana is [AGPL-3.0
license](https://github.com/grafana/grafana/blob/main/LICENSE), which is very
different from Apache 2.0.
diff --git a/docs/en/setup/service-agent/agent-compatibility.md
b/docs/en/setup/service-agent/agent-compatibility.md
index 364d5eeb7a..fe743d24c3 100644
--- a/docs/en/setup/service-agent/agent-compatibility.md
+++ b/docs/en/setup/service-agent/agent-compatibility.md
@@ -1,32 +1,52 @@
# Compatibility
-SkyWalking 8.0+ uses v3 protocols. Agents don't have to keep the identical
versions as the OAP backend.
+SkyWalking uses v3 protocols. Agents don't have to keep the identical versions
as the OAP backend.
+
+**We recommend always using the latest releases of both OAP server and agents
for better performance and advanced
+features.**
## SkyWalking Native Agents
-| OAP Server Version | Java | Python | NodeJS | LUA |
Kong | Browser Agent | Rust | PHP | Go | Rover | Satellite | Ruby
|
-|--------------------|-------------------------|-----------|-----------|-----|------|---------------|------|-----|------------|------------|------------|------------|
-| 8.0.1 - 8.1.0 | 8.0.0 - 8.3.0 | < = 0.6.0 | < = 0.3.0 | All |
All | No | All | No | No | No | No | No
|
-| 8.2.0 - 8.3.0 | 8.0.0 - 8.3.0 | < = 0.6.0 | < = 0.3.0 | All |
All | All | All | No | No | No | No | No
|
-| 8.4.0 - 8.8.1 | \> = 8.0.0 | All | All | All |
All | All | All | All | No | No | No | No
|
-| 8.9.0+ | \> = 8.0.0 | All | All | All |
All | All | All | All | No | No | \> = 0.4.0 | No
|
-| 9.0.0 | \> = 8.0.0 | All | All | All |
All | All | All | All | No | No | \> = 0.4.0 | No
|
-| 9.1.0+ | \> = 8.0.0 | All | All | All |
All | All | All | All | No | \> = 0.1.0 | \> = 1.0.0 | No
|
-| 9.5.0+ | \> = 8.0.0 & \> = 9.0.0 | All | All | All |
All | All | All | All | \> = 0.1.0 | \> = 0.5.0 | \> = 1.2.0 | \> =
0.1.0 |
+### OAP 10.x (Current)
+
+**Agents with specific version requirements:**
+
+| Agent | Minimum Version |
+|-----------|-----------------|
+| Java | 8.x, 9.x |
+| Go | 0.1+ |
+| Rover | 0.5+ |
+| Satellite | 1.2+ |
+
+**Agents compatible with all versions:**
+Python, NodeJS, PHP, Rust, Ruby, Browser, LUA, Kong
+
+### Legacy Versions (8.x - 9.x)
+
+For users on OAP 8.x or 9.x, refer to the table below. Note: these versions
are no longer actively maintained.
+
+| OAP Server Version | Java | Python | NodeJS | Go | Rover | Satellite
| Ruby |
+|--------------------|-----------|--------|--------|------|-------|-----------|------|
+| 9.5 - 9.7 | 8.x, 9.x | All | All | 0.1+ | 0.5+ | 1.2+
| 0.1+ |
+| 9.1 - 9.4 | 8.x | All | All | No | 0.1+ | 1.0+
| No |
+| 9.0 | 8.x | All | All | No | No | 0.4+
| No |
+| 8.4 - 8.9 | 8.x | All | All | No | No | No
| No |
+| 8.0 - 8.3 | 8.0 - 8.3 | 0.6- | 0.3- | No | No | No
| No |
## Ecosystem Agents
-All following agent implementations are a part of the SkyWalking ecosystem.
All the source codes and their distributions
-don't belong to the Apache Software Foundation.
+The following agent implementations are part of the SkyWalking ecosystem.
Their source codes and distributions are
+maintained by their respective communities and don't belong to the Apache
Software Foundation.
-| OAP Server Version | DotNet | cpp2sky |
-|--------------------|---------------|-----------|
-| 8.0.1 - 8.3.0 | 1.0.0 - 1.3.0 | < = 0.2.0 |
-| 8.4.0+ | \> = 1.0.0 | All |
-| 9.0.0+ | \> = 1.0.0 | All |
+| OAP Server Version | DotNet | cpp2sky |
+|--------------------|-----------|----------------|
+| 10.x | 1.0+ | All |
+| 9.x | 1.0+ | All |
+| 8.4+ | 1.0+ | All |
+| 8.0 - 8.3 | 1.0 - 1.3 | 0.2 or earlier |
-All these projects are maintained by their own communities, and please reach
them if you face any compatibility issues.
+Please reach out to their respective communities if you face any compatibility
issues.
___
-All above compatibility are only references, and if you face an
`unimplemented` error, it means you need to upgrade the
-OAP backend to support newer features in the agents.
+The compatibility information above is for reference. If you encounter an
`unimplemented` error, upgrade the OAP backend
+to support newer features in the agents.
diff --git a/docs/en/setup/service-agent/browser-agent.md
b/docs/en/setup/service-agent/browser-agent.md
index 64f86e146c..5cef3b0f61 100644
--- a/docs/en/setup/service-agent/browser-agent.md
+++ b/docs/en/setup/service-agent/browser-agent.md
@@ -8,7 +8,7 @@ It has these features:
See Client JS [official
doc](https://github.com/apache/skywalking-client-js#quick-start) for more
information.
-Note: Make sure receiver-browser is enabled. It is **ON** by default since
version 8.2.0.
+Note: Make sure receiver-browser is enabled. It is **ON** by default.
```yaml
receiver-browser:
diff --git a/docs/menu.yml b/docs/menu.yml
index 9fdf89bdc9..adb2ee8936 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -44,10 +44,10 @@ catalog:
path: "/en/setup/backend/backend-docker"
- name: "Run with Kubernetes"
path: "/en/setup/backend/backend-k8s"
- - name: "Find out-of-box Features in Marketplace"
- path: "/en/setup/backend/marketplace"
- name: "Marketplace"
catalog:
+ - name: "Overview"
+ path: "/en/setup/backend/marketplace"
- name: "General Service"
catalog:
- name: "Server Agents"
