improve agent skills and docs for AI integration#142
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Collaborator
Author
|
@proofkit/better-auth
@proofkit/cli
create-proofkit
@proofkit/fmdapi
@proofkit/fmodata
@proofkit/typegen
@proofkit/webviewer
commit: |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
📝 WalkthroughWalkthroughAdds a changeset and updates documentation and a docs homepage section to warn that schema files and entity IDs must be generated by Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
apps/docs/src/app/(home)/page.tsx (1)
128-151: Use heading elements for feature titles and mark icons as decorative.At Line 128, Line 138, and Line 148, consider
<h3>instead of<div>for feature titles, and set icon components toaria-hidden="true"to avoid noisy screen-reader output.♻️ Suggested refinement
- <div className="flex items-center gap-2 font-semibold"> - <Brain className="size-5 text-brand" /> - Expert knowledge built in - </div> + <h3 className="flex items-center gap-2 font-semibold"> + <Brain aria-hidden="true" className="size-5 text-brand" /> + <span>Expert knowledge built in</span> + </h3> - <div className="flex items-center gap-2 font-semibold"> - <ShieldCheck className="size-5 text-brand" /> - Type-safe by default - </div> + <h3 className="flex items-center gap-2 font-semibold"> + <ShieldCheck aria-hidden="true" className="size-5 text-brand" /> + <span>Type-safe by default</span> + </h3> - <div className="flex items-center gap-2 font-semibold"> - <Bot className="size-5 text-brand" /> - Works with any agent - </div> + <h3 className="flex items-center gap-2 font-semibold"> + <Bot aria-hidden="true" className="size-5 text-brand" /> + <span>Works with any agent</span> + </h3>As per coding guidelines, "Use semantic HTML and ARIA attributes for accessibility ... Use semantic elements (
<button>,<nav>, etc.) instead of divs with roles."🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/docs/src/app/`(home)/page.tsx around lines 128 - 151, Replace the non-semantic title containers with heading elements and mark the icons as decorative: change the three feature title containers that currently use <div className="flex items-center gap-2 font-semibold"> (the ones containing the Brain, ShieldCheck, and Bot icons) to <h3> elements for proper document structure, and add aria-hidden="true" to the Brain, ShieldCheck, and Bot icon components so screen readers ignore them while keeping the visible layout 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 `@packages/typegen/skills/typegen-setup/SKILL.md`:
- Around line 66-75: Update the markdown heading "OData generated output
structure" to use the hyphenated form "OData-generated output structure" and add
a fenced-code language marker to the example block (e.g., change the triple
backticks to include a language like "text") so the schema snippet is properly
highlighted; target the heading and the fenced code block in the SKILL.md
section that contains the schema/odata/generated example (search for the
"fmTableOccurrence" mention and the code fence).
---
Nitpick comments:
In `@apps/docs/src/app/`(home)/page.tsx:
- Around line 128-151: Replace the non-semantic title containers with heading
elements and mark the icons as decorative: change the three feature title
containers that currently use <div className="flex items-center gap-2
font-semibold"> (the ones containing the Brain, ShieldCheck, and Bot icons) to
<h3> elements for proper document structure, and add aria-hidden="true" to the
Brain, ShieldCheck, and Bot icon components so screen readers ignore them while
keeping the visible layout intact.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 91f559b1-a3aa-4792-bb15-84b5c60644d7
📒 Files selected for processing (9)
.changeset/fix-skill-typegen-warnings.mdapps/docs/content/docs/fmodata/index.mdxapps/docs/content/docs/fmodata/quick-start.mdxapps/docs/src/app/(home)/page.tsxpackages/fmdapi/skills/fmdapi-client/SKILL.mdpackages/fmodata/skills/fmodata-client/SKILL.mdpackages/fmodata/skills/odata-query-optimization/SKILL.mdpackages/typegen/skills/getting-started/SKILL.mdpackages/typegen/skills/typegen-setup/SKILL.md
eluce2
commented
Mar 15, 2026
- Add warnings to skills to prevent manually adding fields/entity IDs - Deduplicate common mistakes across skills with cross-refs to typegen-setup - Move tanstack intent install instruction after package install in docs - Add 'Built for AI Agents' section to docs homepage - Add clarifying note to fmodata overview AI section - Restore wrong/correct examples for deduped common mistakes Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
eluce2
force-pushed
the
03-15-improve_agent_skills_and_docs_for_ai_integration
branch
from
94f4443 to
f3980b1
Compare
This was referenced Mar 16, 2026
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.
Co-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com
Summary by CodeRabbit
New Features
Documentation