docs: add AGENTS.md and CLAUDE.md documentation#563
Merged
Conversation
Add new documentation files for agents and Claude-related content. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
WalkthroughAdds AGENTS.md and CLAUDE.md, updates .gitignore to ignore agent artifacts, and expands backup documentation with optional resource-filtering and label-selector configuration in the backup UI flow. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
AGENTS.md (2)
45-58: Add a language to the fenced code block (MD040).Markdownlint requires a language for fenced blocks; use
text(orbashif appropriate) to avoid lint failures.♻️ Proposed fix
-``` +```text acp-docs/ ├── docs/ │ ├── en/ # 英文文档（主语言，修改的首选目标） │ ├── zh/ # 中文文档（通过翻译流程生成，禁止脱离英文版单独修改逻辑） │ ├── public/ # 全局静态资源 │ │ └── logo.svg │ └── shared/ # 共享配置文件（如 CRD, OpenAPI, 暂由人工维护） ├── theme/ # 主题定制 ├── scripts/ # 工具脚本 ├── doom.config.yml # 框架核心配置 └── package.json -``` +```🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 45 - 58, The fenced code block in AGENTS.md is missing a language specifier (MD040); update the opening fence for the directory tree to include a language (e.g., change the opening "```" to "```text" or "```bash") so the block is lint-compliant and keep the matching closing "```"; target the fenced block that contains the acp-docs/ directory tree.
94-96: Optional wording tweak for readability.Consider replacing “关于 …” with “对于 …” or rephrase to avoid the ambiguous prepositional phrase.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 94 - 96, Update the sentence that currently uses the ambiguous prepositional phrase "关于 `Tabs`, `Steps`, `CodeBlock`, `Highlight` 等可用组件的详细用法，请参考关联的 **MDX 组件 Skill**" to improve readability by replacing "关于" with "对于" or rephrasing it; for example, change it to "对于 `Tabs`, `Steps`, `CodeBlock`, `Highlight` 等可用组件的详细用法，请参考关联的 **MDX 组件 Skill**" or an equivalent phrasing that clearly introduces the referenced components and the MDX 组件 Skill.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@AGENTS.md`:
- Around line 45-58: The fenced code block in AGENTS.md is missing a language
specifier (MD040); update the opening fence for the directory tree to include a
language (e.g., change the opening "```" to "```text" or "```bash") so the block
is lint-compliant and keep the matching closing "```"; target the fenced block
that contains the acp-docs/ directory tree.
- Around line 94-96: Update the sentence that currently uses the ambiguous
prepositional phrase "关于 `Tabs`, `Steps`, `CodeBlock`, `Highlight`
等可用组件的详细用法，请参考关联的 **MDX 组件 Skill**" to improve readability by replacing "关于"
with "对于" or rephrasing it; for example, change it to "对于 `Tabs`, `Steps`,
`CodeBlock`, `Highlight` 等可用组件的详细用法，请参考关联的 **MDX 组件 Skill**" or an equivalent
phrasing that clearly introduces the referenced components and the MDX 组件 Skill.
Deploying alauda-container-platform with
|
| Latest commit: |
ecbc65b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4c0f7024.alauda-container-platform.pages.dev |
| Branch Preview URL: | https://add-agents-docs.alauda-container-platform.pages.dev |
Add documentation for four new resource filtering fields in the application backup UI: - Included Namespace Resources: Select specific namespace-scoped resource types - Included Cluster Resources: Whitelist for cluster-scoped resources - Excluded Namespace Resources: Exclude specific namespace-scoped resource types - Label Selectors: Filter resources by matchLabels and matchExpressions These options allow users to refine backup scope, particularly useful for scenarios like excluding large datasets (e.g., ClickHouse) from PVC backups. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Rewrite AGENTS.md in English with clearer structure and formatting - Add sections for Project Context, Core Principles, Build Commands, Documentation Guidelines, Immutable Files, and Definition of Done - Add .gitignore entries for Claude Code skill directories: - .claude/ - .agents/ - skills-lock.json Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/en/configure/backup/application/backup-app.mdx`:
- Around line 71-78: Clarify the label selector section: state that "OR logic"
applies only when the UI maps to Velero's orLabelSelectors (which accepts
multiple LabelSelectors joined by OR) and note that orLabelSelectors and the
single labelSelector are mutually exclusive in a backup; update the paragraph
mentioning "Multiple selectors are combined with OR logic" to reference
orLabelSelectors explicitly and add a short note that a single labelSelector
uses AND logic. Also correct the matchLabels table to show that Value is
required per Kubernetes' map[string]string, or if the UI treats a missing value
as an "exists" match, document that behavior explicitly and explain that the UI
translates that case into matchExpressions rather than a plain matchLabels
entry.
- Around line 71-78: Update the documentation to clarify that "Multiple
selectors are combined with OR logic" only applies when using the Velero API
field spec.orLabelSelectors (v1.10+); state that the standard spec.labelSelector
/ single selector uses AND semantics and ensure the UI description explicitly
maps to spec.orLabelSelectors if OR is intended. Also correct the matchLabels
table: change "Value | string (optional)" to required (map[string]string
requires both key and value) or, if the UI allows key-only matching, document
that this is a UI-specific deviation and show the correct Kubernetes alternative
using matchExpressions with operator: Exists; reference matchLabels,
matchExpressions, operator: Exists, spec.labelSelector, and
spec.orLabelSelectors so the author knows which fields to adjust.
- Around line 88-90: Update the note to clarify that the annotation
backup.velero.io/backup-volumes-excludes only prevents filesystem-level backups
of volumes (when defaultVolumesToFsBackup causes PVCs to be backed up), but does
not prevent volumes from being captured by configured volume snapshot
mechanisms; mention defaultVolumesToFsBackup and the annotation name
(backup.velero.io/backup-volumes-excludes) so readers understand the distinction
between FS backup exclusion and snapshot-based backups.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.gitignoreAGENTS.mddocs/en/configure/backup/application/backup-app.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- AGENTS.md
….mdx - Fix matchLabels Value field from (optional) to (required) per Kubernetes spec - Clarify backup-volumes-excludes annotation behavior (filesystem vs snapshot) - Refactor excessive ::: directives from 9 to 3 per Doom framework standards - Convert low-priority directives to plain text/bold/lists for better readability - Add guidance for using matchExpressions with Exists operator Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/en/configure/backup/application/backup-app.mdx (1)
60-81: Label Selectors section correctly addresses all prior review feedback.The
orLabelSelectorsOR-logic clarification, mutual exclusivity note, correctedmatchLabelsValue requirement,Existsoperator guidance, and PVC filesystem-vs-snapshot distinction are all accurately documented.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/en/configure/backup/application/backup-app.mdx` around lines 60 - 81, The review text contains redundant review markers—remove the duplicate approval/comment artifacts so the documentation change stands with a single approval note; specifically, in the "Label Selectors" section and surrounding review text referencing orLabelSelectors, matchLabels, matchExpressions, defaultVolumesToFsBackup, and the backup.velero.io/backup-volumes-excludes annotation, delete the extraneous "[approve_code_changes]" and "[duplicate_comment]" tokens (leaving the content and clarifications intact).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/en/configure/backup/application/backup-app.mdx`:
- Around line 46-48: Update the warning block string that currently reads "To
ensure reliability and integrity, do not back up database data (for example,
MySQL-PXC, Redis). Use Data Services for database backups." to use consistent
wording with the earlier warning by changing "integrity" to "data integrity" so
it reads "To ensure reliability and data integrity, do not back up database data
(for example, MySQL-PXC, Redis). Use Data Services for database backups." This
targets the :::warning block text in backup-app.mdx.
---
Duplicate comments:
In `@docs/en/configure/backup/application/backup-app.mdx`:
- Around line 60-81: The review text contains redundant review markers—remove
the duplicate approval/comment artifacts so the documentation change stands with
a single approval note; specifically, in the "Label Selectors" section and
surrounding review text referencing orLabelSelectors, matchLabels,
matchExpressions, defaultVolumesToFsBackup, and the
backup.velero.io/backup-volumes-excludes annotation, delete the extraneous
"[approve_code_changes]" and "[duplicate_comment]" tokens (leaving the content
and clarifications intact).
- Remove duplicate database backup warning (already present in document header) - Add blank line between Scheduled and Advanced configuration sections - Further reduce ::: directives from 3 to 2 for better compliance with Doom standards Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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.
Add new documentation files for agents and Claude-related content.
Summary by CodeRabbit
New Features
Documentation
Chores