-
-
Notifications
You must be signed in to change notification settings - Fork 781
chore: ai docs revamp #7879
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: ai docs revamp #7879
Conversation
|
WalkthroughThis PR adds Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolCONTRIBUTING.md[uncategorized] ~60-~60: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) 🔇 Additional comments (1)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.github/PULL_REQUEST_TEMPLATE.md(1 hunks)AGENTS..md(1 hunks)CLAUDE.md(0 hunks)CLAUDE.md(1 hunks)CONTRIBUTING.md(2 hunks)
🧰 Additional context used
🪛 GitHub Actions: Pull request Markdown
AGENTS..md
[error] 61-61: MD028/no-blanks-blockquote Blank line inside blockquote https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md
🪛 GitHub Check: lint
CONTRIBUTING.md
[failure] 61-61: Blank line inside blockquote
CONTRIBUTING.md:61 MD028/no-blanks-blockquote Blank line inside blockquote https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~54-~54: Possible missing article found.
Context: ... If you avail of AI assistance to make pull request, you must disclose it in the pu...
(AI_HYDRA_LEO_MISSING_A)
[uncategorized] ~62-~62: Possible missing comma found.
Context: ...ulted ChatGPT to understand the codebase but the solution > was fully authored manua...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (3)
.github/PULL_REQUEST_TEMPLATE.md (1)
1-5: AI-assistance disclosure block is well-placed and correct.The new HTML comment block clearly prompts contributors to disclose AI assistance and provides a direct link to the policy. Good positioning at the top of the template.
CONTRIBUTING.md (1)
47-72: AI assistance notice section is well-written and appropriately emphatic.The new section clearly communicates the disclosure requirement with good rationale, practical examples, and a respectful tone toward maintainers. Once the formatting and grammar issues are resolved, this will be solid.
AGENTS..md (1)
1-1: File doesn't exist—review comment is based on incorrect assumptions.The file AGENTS.md (or AGENTS..md) doesn't exist in the repository. If the PR intends to add this file, verify it's actually been committed; if not, this review comment is premature. If the file was meant to exist elsewhere or under a different name, clarify with the PR author.
Likely an incorrect or invalid review comment.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nicolas Hedger <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Nicolas Hedger <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Nicolas Hedger <[email protected]>
Summary
This PR revamps the AI usage inside this repository
CLAUDE.mdis now a symbolic link to the contribution guideAGENTS.md, which is now a symbolic link to the contribution guideTest Plan
Docs