Skip to content

*: merge docs/note into docs/agents#67192

Merged
ti-chi-bot[bot] merged 1 commit intopingcap:masterfrom
D3Hunter:codex/merge-docs-note-into-agents
Mar 20, 2026
Merged

*: merge docs/note into docs/agents#67192
ti-chi-bot[bot] merged 1 commit intopingcap:masterfrom
D3Hunter:codex/merge-docs-note-into-agents

Conversation

@D3Hunter
Copy link
Copy Markdown
Contributor

@D3Hunter D3Hunter commented Mar 20, 2026

What problem does this PR solve?

Issue Number: ref #63847

Problem Summary:
Agent-facing component notes were split across two top-level folders (docs/note and docs/agents), making discovery and maintenance inconsistent. This PR consolidates component notes under a single top-level location.

What changed and how does it work?

This PR migrates component notes from docs/note/* into docs/agents/<component>/* and updates all cross-references accordingly.

Key changes:

  • Move component note trees:
    • docs/note/planner/* -> docs/agents/planner/*
    • docs/note/executor/* -> docs/agents/executor/*
    • docs/note/dxf/* -> docs/agents/dxf/*
    • docs/note/import-into/* -> docs/agents/import-into/*
  • Remove docs/note/README.md (legacy top-level notes index).
  • Add docs/agents/README.md to define the new docs layout.
  • Update references in:
    • docs/agents/notes-guide.md
    • docs/agents/architecture-index.md
    • docs/agents/dxf/README.md
  • Include existing in-flight updates in AGENTS.md from the current working tree, per requested all-change commit.

Validation run:

  • rg -n "docs/note/" AGENTS.md docs/agents -g '*.md'
  • Wildcard-aware docs reference audit over AGENTS.md + docs/agents/**/*.md:
    • broken refs: none
    • reachability from AGENTS.md: 23/23 markdown files

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)

before
img_v3_02vv_9cae1987-5659-4052-87be-f259648af9ag

after
img_v3_02vv_bc231c0c-2d1f-4b0a-9321-b255393f0f6g

  • No need to test
    • I checked and no code files have been changed.
    • Markdown/path-only migration; verified docs references and reachability.

Side effects

  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Breaking backward compatibility

Documentation

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Changes MySQL compatibility

Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

None

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 20, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 20, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

Documentation reorganization moving agent-facing content from docs/note/ to docs/agents/, establishing docs/agents/README.md as the centralized entry point. Updates internal path references and adds guidance for agent interaction overrides in AGENTS.md.

Changes

Cohort / File(s) Summary
Core Agent Documentation Structure
AGENTS.md, docs/agents/README.md, docs/note/README.md
Added "Agent Interaction Overrides (Repo-Local)" section to AGENTS.md; created new README.md at docs/agents/ defining the organizational scheme for agent documentation; removed README content from docs/note/.
Agent Documentation Path Updates
docs/agents/architecture-index.md, docs/agents/dxf/README.md, docs/agents/notes-guide.md
Updated internal documentation references to reflect move of agent notes from docs/note/ to docs/agents/, including planner rule notes and import-into documentation paths.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

Suggested labels

size/L, approved, lgtm

Suggested reviewers

  • hawkingrei
  • lance6716
  • GMHDBJD

Poem

🐰 Hops through docs with careful care,
Moving notes from here to there,
Agent guides now neatly live,
In docs/agents/ we preserve,
Organization—what a swerve! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title '*: merge docs/note into docs/agents' directly and clearly summarizes the main change—consolidating documentation from two locations into one.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description comprehensively follows the required template with all essential sections completed: issue number, problem summary, detailed change description, thorough validation steps, appropriate test selection, and release note handling.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can use Trivy to scan for security misconfigurations and secrets in Infrastructure as Code files.

Add a .trivyignore file to your project to customize which findings Trivy reports.

@tiprow
Copy link
Copy Markdown

tiprow bot commented Mar 20, 2026

Hi @D3Hunter. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@hawkingrei
Copy link
Copy Markdown
Member

/ok-to-test

@ti-chi-bot ti-chi-bot bot added the ok-to-test Indicates a PR is ready to be tested. label Mar 20, 2026
@D3Hunter D3Hunter marked this pull request as ready for review March 20, 2026 12:40
@ti-chi-bot ti-chi-bot bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 20, 2026
@pantheon-ai
Copy link
Copy Markdown

pantheon-ai bot commented Mar 20, 2026

Review Complete

Findings: 0 issues
Posted: 0
Duplicates/Skipped: 0

ℹ️ Learn more details on Pantheon AI.

@ti-chi-bot ti-chi-bot bot added approved needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Mar 20, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 20, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hawkingrei, wjhuang2016

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [hawkingrei,wjhuang2016]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Mar 20, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot bot commented Mar 20, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-03-20 12:51:37.956487332 +0000 UTC m=+534225.044144879: ☑️ agreed by hawkingrei.
  • 2026-03-20 13:11:42.530007722 +0000 UTC m=+535429.617665259: ☑️ agreed by wjhuang2016.

@ti-chi-bot ti-chi-bot bot merged commit 0511849 into pingcap:master Mar 20, 2026
13 checks passed
Copy link
Copy Markdown

@pantheon-ai pantheon-ai bot left a comment

Choose a reason for hiding this comment

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

✅ Code looks good. No issues found.

@D3Hunter D3Hunter deleted the codex/merge-docs-note-into-agents branch March 20, 2026 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm ok-to-test Indicates a PR is ready to be tested. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants