Skip to content

Minor upgrades for documentation#458

Merged
nadheesh merged 4 commits intowso2:mainfrom
AnoshanJ:feat/documentation-new-0.7
Feb 26, 2026
Merged

Minor upgrades for documentation#458
nadheesh merged 4 commits intowso2:mainfrom
AnoshanJ:feat/documentation-new-0.7

Conversation

@AnoshanJ
Copy link
Copy Markdown
Contributor

@AnoshanJ AnoshanJ commented Feb 26, 2026

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Update structure of documentation and add updates for v0.7 (quickstart/self-hosted/managed)

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter �N/A� plus brief explanation of why there�s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type �Sent� when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type �N/A� and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation
    • Removed several component docs (agent manager API, console, trace observer, evaluation framework) and associated versioned pages.
    • Updated getting-started guides and examples to v0.7.0 and added the Evaluation Extension install/config notes.
    • Added a new Observability concept page and a "Monitor Your First Agent" tutorial.
    • Updated site navigation to introduce Concepts and Tutorials and remove the deleted component pages.

@AnoshanJ AnoshanJ requested a review from nadheesh February 26, 2026 11:41
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 26, 2026

Warning

Rate limit exceeded

@AnoshanJ has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 2 minutes and 6 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8fd0df7 and e0150ed.

📒 Files selected for processing (4)
  • website/docs/concepts/observability.mdx
  • website/docs/getting-started/quick-start.mdx
  • website/docs/tutorials/observe-first-agent.mdx
  • website/sidebars.ts
📝 Walkthrough

Walkthrough

Deletes multiple component docs (amp-api, amp-console, amp-trace-observer, amp-eval and its v0.6.x version), adds Observability concept and a Monitor-first-agent tutorial, updates getting-started docs and quick-start to v0.7.0 and adds an Evaluation Extension, and adjusts the website sidebar navigation.

Changes

Cohort / File(s) Summary
Removed Component Docs
website/docs/components/amp-api.mdx, website/docs/components/amp-console.mdx, website/docs/components/amp-trace-observer.mdx, website/docs/components/amp-eval.mdx, website/versioned_docs/version-v0.6.x/components/amp-eval.mdx
Complete deletions of multiple component documentation pages, removing API, console, trace observer, and evaluation framework docs (large content removals).
New Concept & Tutorial
website/docs/concepts/observability.mdx, website/docs/tutorials/monitor-first-agent.mdx
Added an Observability concept page (OpenTelemetry, instrumentation scope, trace attributes) and a tutorial to monitor an external agent with amp-instrumentation.
Getting Started / Version bumps
website/docs/getting-started/managed-cluster.mdx, website/docs/getting-started/self-hosted-cluster.mdx, website/docs/getting-started/quick-start.mdx
Updated many deployment references from v0.6.0 to v0.7.0, added an Evaluation Extension to install steps, added notes about matching publisher API keys, and fixed a markdown fence in quick-start.
Sidebar / Navigation
website/sidebars.ts, website/versioned_sidebars/version-v0.6.x-sidebars.json
Updated sidebar: added Concepts and Tutorials categories, removed several component entries (including amp-eval) from Components, and adjusted versioned sidebar entries.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I hopped through docs both old and new,

Old pages fell, new pages grew,
Traces, observability — a curious song,
Version bumps carried the march along,
I nibble the sidebar and bound along!

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description consists entirely of an unfilled template scaffold with no substantive content addressing the actual changes made in the PR. Complete the description template with actual details: explain which docs were removed/added, why the restructuring was necessary, link related issues, and fill in relevant sections like Release note and Documentation.
Title check ❓ Inconclusive The title 'Minor upgrades for documentation' is vague and generic, using non-descriptive language that fails to convey the specific nature of the changes. Use a more specific title that clearly describes the main changes, such as 'Restructure documentation and update for v0.7 release' or 'Remove component docs and add observability/monitoring guides'.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
website/docs/getting-started/managed-cluster.mdx (1)

455-455: ⚠️ Potential issue | 🟡 Minor

Incorrect step reference.

The note references "Phase 1, Step 5" but the Observability Plane installation is actually "Step 4" in Phase 1 (lines 195-223). Step 5 is "Configure Observability Integration."

✏️ Suggested fix
-**Note:** The OpenTelemetry Collector ConfigMap should have been applied in Phase 1, Step 5. If you skipped it, apply it now:
+**Note:** The OpenTelemetry Collector ConfigMap should have been applied in Phase 1, Step 4. If you skipped it, apply it now:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/getting-started/managed-cluster.mdx` at line 455, Update the
note that currently reads "Phase 1, Step 5" to instead reference "Phase 1, Step
4" so it correctly points to the Observability Plane installation (the
OpenTelemetry Collector ConfigMap); locate the paragraph containing
"OpenTelemetry Collector ConfigMap should have been applied" and replace the
step number, ensuring you do not change the surrounding wording or the reference
to "Configure Observability Integration."
🧹 Nitpick comments (1)
website/docs/getting-started/self-hosted-cluster.mdx (1)

522-568: Consider adding Evaluation Extension verification.

The Verification section doesn't include a specific check for the new Evaluation Extension added in Step 7. For consistency with other extensions, consider adding a verification step:

# 5.5. Check Evaluation Extension (if installed)
echo "=== Evaluation Extension Status ==="
kubectl get pods -n openchoreo-build-plane | grep -E "amp-evaluation"

Alternatively, a general helm list -n openchoreo-build-plane check already covers it, so this is optional.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/getting-started/self-hosted-cluster.mdx` around lines 522 - 568,
Add a Verification step for the Evaluation Extension inside the "Verification"
section (near the existing "Check Build Extension" block) that runs against the
openchoreo-build-plane namespace and looks for pods matching amp-evaluation
(e.g., similar to the existing Build Extension check using kubectl get pods -n
openchoreo-build-plane | grep -E "amp-evaluation"); label it consistently (e.g.,
"Check Evaluation Extension Status") so it mirrors other extension checks and is
optional if not installed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@website/docs/concepts/observability.mdx`:
- Line 11: The sentence "Every agent interaction — LLM calls, tool invocations,
MCP requests, retrieval operations, and agent reasoning steps is captured..."
has a subject-verb agreement/punctuation issue; update that sentence (the line
containing "Every agent interaction — LLM calls, tool invocations, MCP requests,
retrieval operations, and agent reasoning steps is captured") to use correct
grammar and punctuation, e.g., change "is captured" to "are captured" or
restructure the clause with proper dashes/commas so it reads "Every agent
interaction — LLM calls, tool invocations, MCP requests, retrieval operations,
and agent reasoning steps — is captured" or "Every agent interaction, such as
LLM calls, tool invocations, MCP requests, retrieval operations, and agent
reasoning steps, is captured" to fix agreement and punctuation.
- Around line 41-43: The "Trace Visibility in AMP Console" heading currently
ends mid-sentence; expand that paragraph under the "Trace Visibility in AMP
Console" section to include concise instructions on how to access the AMP
Console, where traces appear (e.g., Traces or Observability dashboard), brief
steps to filter/search traces, and a link to the relevant tutorial or docs page;
mention the section name "Trace Visibility in AMP Console" so you add a short
example of viewing a single trace and tips for useful filters.

In `@website/docs/getting-started/self-hosted-cluster.mdx`:
- Around line 114-117: The four hardcoded URLs in
website/docs/getting-started/self-hosted-cluster.mdx that point to amp/v0.7.0
(the entries for values-bp.yaml, values-op.yaml, values-cp.yaml, values-dp.yaml)
must be updated to reference an existing tag—either change amp/v0.7.0 to
amp/v0.6.0 or to a valid rc tag such as amp/v0.7.0-rc9 depending on which
release you want to document; update each URL consistently so the links resolve
(values-bp.yaml, values-op.yaml, values-cp.yaml, values-dp.yaml).

In `@website/docs/tutorials/monitor-first-agent.mdx`:
- Around line 39-44: The tutorial uses
AMP_OTEL_ENDPOINT="http://localhost:22893/otel" which conflicts with the Quick
Start's OpenTelemetry Collector port 21893; update the example to match the
Quick Start (use 21893) or make it explicit that the port should match the
user's AMP instance/Quick Start (e.g., keep AMP_OTEL_ENDPOINT but change port to
21893 or add a note referencing the Quick Start port), and ensure the text
around AMP_OTEL_ENDPOINT and the sentence "Replace the endpoint..." clearly
instructs users to use the Quick Start's OTLP HTTP endpoint if different.

---

Outside diff comments:
In `@website/docs/getting-started/managed-cluster.mdx`:
- Line 455: Update the note that currently reads "Phase 1, Step 5" to instead
reference "Phase 1, Step 4" so it correctly points to the Observability Plane
installation (the OpenTelemetry Collector ConfigMap); locate the paragraph
containing "OpenTelemetry Collector ConfigMap should have been applied" and
replace the step number, ensuring you do not change the surrounding wording or
the reference to "Configure Observability Integration."

---

Nitpick comments:
In `@website/docs/getting-started/self-hosted-cluster.mdx`:
- Around line 522-568: Add a Verification step for the Evaluation Extension
inside the "Verification" section (near the existing "Check Build Extension"
block) that runs against the openchoreo-build-plane namespace and looks for pods
matching amp-evaluation (e.g., similar to the existing Build Extension check
using kubectl get pods -n openchoreo-build-plane | grep -E "amp-evaluation");
label it consistently (e.g., "Check Evaluation Extension Status") so it mirrors
other extension checks and is optional if not installed.

ℹ️ Review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 725d157 and 623f02e.

📒 Files selected for processing (9)
  • website/docs/components/amp-api.mdx
  • website/docs/components/amp-console.mdx
  • website/docs/components/amp-trace-observer.mdx
  • website/docs/concepts/observability.mdx
  • website/docs/getting-started/managed-cluster.mdx
  • website/docs/getting-started/quick-start.mdx
  • website/docs/getting-started/self-hosted-cluster.mdx
  • website/docs/tutorials/monitor-first-agent.mdx
  • website/sidebars.ts
💤 Files with no reviewable changes (3)
  • website/docs/components/amp-console.mdx
  • website/docs/components/amp-trace-observer.mdx
  • website/docs/components/amp-api.mdx

Comment thread website/docs/concepts/observability.mdx Outdated
Comment thread website/docs/concepts/observability.mdx Outdated
Comment on lines +114 to +117
| **Build Plane** | [values-bp.yaml](https://raw.githubusercontent.com/wso2/agent-manager/amp/v0.7.0/deployments/single-cluster/values-bp.yaml) |
| **Observability Plane** | [values-op.yaml](https://raw.githubusercontent.com/wso2/agent-manager/amp/v0.7.0/deployments/single-cluster/values-op.yaml) |
| **Control Plane** | [values-cp.yaml](https://raw.githubusercontent.com/wso2/agent-manager/amp/v0.7.0/deployments/single-cluster/values-cp.yaml) |
| **Data Plane** | [values-dp.yaml](https://raw.githubusercontent.com/wso2/agent-manager/amp/v0.7.0/deployments/single-cluster/values-dp.yaml) |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Test URL accessibility for the v0.7.0 references

echo "=== Testing URL accessibility ==="

# Test one of the URLs mentioned in the documentation
test_url="https://raw.githubusercontent.com/wso2/agent-manager/amp/v0.7.0/deployments/single-cluster/values-bp.yaml"
echo "Testing: $test_url"
curl -sI "$test_url" | head -n 1

# Also test if a typical v0.7.0 tag (without amp/) exists
echo ""
echo "Testing alternative tag format (without 'amp' prefix):"
test_url2="https://raw.githubusercontent.com/wso2/agent-manager/v0.7.0/deployments/single-cluster/values-bp.yaml"
echo "Testing: $test_url2"
curl -sI "$test_url2" | head -n 1

# Check what branches/tags are available
echo ""
echo "=== Checking available refs in repository ==="
curl -s "https://api.github.com/repos/wso2/agent-manager/git/refs/tags" | head -c 500

Repository: wso2/agent-manager

Length of output: 951


🏁 Script executed:

#!/bin/bash
# Get all available tags to find the correct version reference

echo "=== All available tags in wso2/agent-manager ==="
curl -s "https://api.github.com/repos/wso2/agent-manager/git/refs/tags" | jq -r '.[].ref' | sort

Repository: wso2/agent-manager

Length of output: 1322


The documentation references the non-existent v0.7.0 tag—only release candidates exist.

The URLs point to amp/v0.7.0, which does not exist in the repository. The latest release is amp/v0.6.0, with only release candidates available for v0.7.0 (amp/v0.7.0-rc1 through amp/v0.7.0-rc9). Either update the documentation to reference a released version or create and tag the v0.7.0 release before merging.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/getting-started/self-hosted-cluster.mdx` around lines 114 - 117,
The four hardcoded URLs in website/docs/getting-started/self-hosted-cluster.mdx
that point to amp/v0.7.0 (the entries for values-bp.yaml, values-op.yaml,
values-cp.yaml, values-dp.yaml) must be updated to reference an existing
tag—either change amp/v0.7.0 to amp/v0.6.0 or to a valid rc tag such as
amp/v0.7.0-rc9 depending on which release you want to document; update each URL
consistently so the links resolve (values-bp.yaml, values-op.yaml,
values-cp.yaml, values-dp.yaml).

Comment thread website/docs/tutorials/monitor-first-agent.mdx Outdated
@AnoshanJ AnoshanJ changed the title Feat/documentation new 0.7 Minor upgrades for documentation Feb 26, 2026
@@ -0,0 +1,86 @@
---
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are not releasing the SDK. Do we need this tutorial?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tutorial is an observability one, I renamed it

nadheesh
nadheesh previously approved these changes Feb 26, 2026
@nadheesh nadheesh merged commit 49b1955 into wso2:main Feb 26, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants