Add ai-agents/claude.md for intro standardization#503
Add ai-agents/claude.md for intro standardization#503
Conversation
# Conflicts: # modules/ROOT/nav.adoc
Added 7 new documentation files for AI Gateway: - what-is-ai-gateway.adoc: Overview, problem/solution framing, common patterns - quickstart-enhanced.adoc: Step-by-step quickstart with time markers - observability-logs.adoc: Request logs, filtering, and debugging - observability-metrics.adoc: Dashboards, analytics, and cost tracking - migration-guide.adoc: Safe migration from direct provider integration - cel-routing-cookbook.adoc: CEL routing patterns with examples - mcp-aggregation-guide.adoc: MCP aggregation and orchestration All files follow Redpanda documentation standards: - Sentence case headings - Imperative verbs for action headings - AsciiDoc format - Comprehensive placeholders for product-specific details Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add personas, learning objectives, and prerequisites to all AI Gateway documentation pages. Remove DRAFT prefixes from titles and time estimates from quickstart. Fix passive voice in multiple locations. Changes: - Add page-personas attributes to all 7 files - Add learning objectives in ABCD format - Add prerequisites sections where missing - Remove "DRAFT:" from all page titles - Remove time estimates from quickstart-enhanced.adoc - Fix passive voice constructions - Improve page descriptions - Preserve all placeholder comments for future content Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Provide admin and user guides for configuring Claude Code, Cline, Continue.dev, Cursor IDE, and GitHub Copilot to work with AI Gateway, enabling centralized LLM routing and MCP tool aggregation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Fix period usage in numbered steps and bold labels across all AI agent docs - Add descriptive link text to xref anchor links for better accessibility - Redesign monitor-agents.adoc reducing lists from 9 to 2, converting to prose and tables - Create observability index page - Fix broken xref from billing.adoc to observability/concepts.adoc
- Change negative headings to positive action-oriented headings - Add explicit 'Enter this query' instructions for each test scenario - Add guidance on what to watch for in the conversation panel - Specify when to start new sessions for context clearing
Moved monitoring how-tos into context where users need them: - Monitor Agents now in agents section - Monitor MCP Servers now in mcp/remote section - Observability concepts remain centralized as single source of truth This follows the "procedures in context, concepts centralized" pattern, reducing navigation overhead and improving task completion. Also removed unnecessary observability index page since only one page remains in that section. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sessions and tasks topics are being soft-hidden with __ prefix as they are internal implementation details. Updated documentation to focus on user-facing monitoring features (transcripts and inspector). Changes: - Remove "Agent data topics" section from concepts.adoc with schemas - Remove "Consume agent data topics" section from monitor-agents.adoc - Update troubleshooting.adoc to reference transcripts instead of topics - Update learning objective to "Track token usage and performance metrics" - Fix xref anchor links to include descriptive text - Fix shipping carrier name to comply with Google style guide Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
…oud-team-polish-clean-up # Conflicts: # modules/ROOT/nav.adoc # modules/ai-agents/pages/mcp/index.adoc
# Conflicts: # modules/ai-agents/pages/observability/concepts.adoc
…lish-clean-up' into adp-pkg1 # Conflicts: # modules/ai-agents/pages/mcp/remote/tool-patterns.adoc
…lish-clean-up' into adp-pkg1
…lish-clean-up' into adp-pkg1 # Conflicts: # modules/ai-agents/pages/mcp/overview.adoc
# Conflicts: # modules/ai-agents/pages/index.adoc # modules/get-started/pages/cloud-overview.adoc
# Conflicts: # modules/ai-agents/pages/index.adoc
# Conflicts: # modules/ai-agents/pages/index.adoc
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
@kbatuigas let's talk about this. Some of this claude.md could be incorporated into the docs-team-standards plugin because it could apply to other module/repos too; e.g., word count targets, intro structure. I'm not sure what is specific to the AI Agents module. |
|
What is the status of this PR @kbatuigas? Please provide and update. Thx |
|
Status: after earlier discussions with team, we've decided that the intro patterns should be applicable and usable across RP docs, not just ADP. I updated the proposed skill and resource in https://github.com/redpanda-data/docs-team-standards/pull/2844 and we may not need this PR when 2844 is merged. |
|
With https://github.com/redpanda-data/docs-team-standards/pull/2844 merged we can close this. |
Description
Create specific Claude Code guidance/memory for ADP doc intros: adds module-specific guidance for writing outcome-focused, executive-friendly introductions across all ai-agents pages. Covers 9 topic types (concepts, how-to, overview, tutorial, etc.) with length targets, examples, and anti-patterns.
Example of first rewrite for observability/transcripts section: 4708a4e
Why claude.md in this directory vs alternatives:
deployment)
Relationship to docs-team-standards plugin:
For more info on CLAUDE.md, see official docs https://code.claude.com/docs/en/memory
Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
Checks