Skip to content

docs(AGENTS.md): cross-reference remaining project README files#13035

Open
jsonmp-k8 wants to merge 1 commit intokubeflow:masterfrom
jsonmp-k8:docs/agents-readme-crossrefs
Open

docs(AGENTS.md): cross-reference remaining project README files#13035
jsonmp-k8 wants to merge 1 commit intokubeflow:masterfrom
jsonmp-k8:docs/agents-readme-crossrefs

Conversation

@jsonmp-k8
Copy link
Contributor

Summary

  • Follows up on docs(AGENTS.md): reference backend/README.md for backend work #13032 to add the remaining 7 README/CONTRIBUTING cross-references to AGENTS.md
  • Each reference is placed in the section where it's most useful:
    • CONTRIBUTING.md (root) → Commit policy section
    • api/README.md → Regenerate protobufs section
    • backend/api/README.md → Regenerate protobufs section
    • frontend/README.md → Key paths section
    • kubernetes_platform/README.md → Key paths section
    • manifests/kustomize/README.md → Local cluster deployment section
    • test/README.md → Local testing section

Test plan

  • Verify all referenced files exist
  • Verify references render correctly in markdown

Copilot AI review requested due to automatic review settings March 14, 2026 03:09
@google-oss-prow
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign humairak for approval. For more information see the Kubernetes Code Review Process.

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

Details Needs approval from an approver in each of these files:

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

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds remaining internal documentation cross-references in AGENTS.md so contributors can quickly find the appropriate README/CONTRIBUTING guidance for common workflows (commit policy, protobuf regeneration, deployments, and testing).

Changes:

  • Updates AGENTS.md “Last updated” date.
  • Adds references to remaining repo READMEs/CONTRIBUTING docs in the most relevant sections (commit policy, deployment, testing, protobuf generation, and key paths).

@jsonmp-k8
Copy link
Contributor Author

/ok-to-test

Add CLAUDE.md referencing AGENTS.md for Claude Code configuration.
Cross-reference remaining README/CONTRIBUTING files in AGENTS.md.

Signed-off-by: Jaison Paul <[email protected]>
@jsonmp-k8 jsonmp-k8 force-pushed the docs/agents-readme-crossrefs branch from a51de1d to 1ad36b7 Compare March 14, 2026 05:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants