docs: review fixes, Mermaid architecture diagrams, licensing details, and troubleshooting playbooks - #823
Merged
Merged
Conversation
…e GKE Prometheus step
There was a problem hiding this comment.
Code Review
This pull request updates the documentation by replacing LaTeX-style arrows with standard unicode arrows, adding comments about AWS Bedrock model IDs in the LLM integration guide, and introducing a step to install Prometheus via Helm in the agent installation guide. A review comment correctly points out that the Prometheus installation step is missing the registration of the "prometheus-community" Helm repository, which would cause the installation command to fail, and provides a code suggestion to add the repository registration commands.
…ehensive server/agent troubleshooting playbooks
…avigation sidebar
…m topology for landing page
… microservices, and durable execution
…ference architecture and streamline landing page
…ent client-side parse errors
…md to ensure crisp, centered rendering
…rchitecture diagram and structured 9-layer reference table
…eractive Mermaid diagrams for runtime microservices
…ties with external pricing link
RamanKharchee
approved these changes
Aug 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of Changes
This PR incorporates all review feedback from PR #822 and introduces comprehensive visual, architectural, and diagnostic enhancements:
1. Licensing Clarifications (editions.md)
k8s-agent) and Proxy Agent (forager).2. Modern Mermaid Architecture Diagrams
3. Server Installation Troubleshooting Playbook (installation/server/index.md)
Upgraded Section 7 into a structured diagnostic guide covering:
proxy-read-timeout: 3600).4. In-Depth Agent Troubleshooting Guide (installation/agent/installation/index.md)
Added diagnostic scenarios for:
node-agenteBPF probe load failures on Bottlerocket, Talos, and GKE COS (with fallback--set nodeAgent.ebpf.enabled=false).NetworkPolicydefinitions.5. Review & Syntax Fixes
→).Verification
npm run buildinsidedoc-server: 0 errors, 0 broken links, 0 broken anchors.