Repository navigation
docs(skills): Add blocks guidance and other agents setup instructions - #17
Conversation
…t-skills feat(skills): Improve Edit Page Content Skill
ty tony Co-authored-by: Tony Li <runnabro@users.noreply.github.com>
…n-skill feat(navigation): Improve manage navigation skill
…kill feat(project-creation): RM-18984 Create Project Skill
…oject-settings-skill
…settings-skill feat(update-project-settings): RM-18985 Add project settings skill for PATCH /v2/projects/me
 |
|
(agent response) |
xavierandueza
left a comment
xavierandueza
left a comment
There was a problem hiding this comment.
self-reviewed, LGTM
xavierandueza
changed the title
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| For MCP use the `/v2/search` endpoint via `execute-request` and if search is insufficient, retrieve categories for the section (`v2/branches/{branch}/categories/{section}`) then pages within categories (`/v2/branches/{branch}/categories/{section}/{title}/pages`) | ||
| **Done:** The exact page and full current body/metadata are available, or the new page's category and slug are agreed. | ||
| 3. **Draft** Ensure that you have a strong idea of what the user wants, and what you can use in the page. Refer to the [ReadMe docs mdx page](https://docs.readme.com/main/docs/mdx.md) to understand how to write valid MDX. ReadMe offers several [built-in components](https://docs.readme.com/main/docs/built-in-components.md) that can be leveraged in every project. Apply the page-type concerns below. Existing projects may also have users who have setup [reusable content](https://docs.readme.com/main/docs/reusable-content.md) for their project that can also be utilized. | ||
| 3. **Draft** Ensure that you have a strong idea of what the user wants, and what you can use in the page. Refer to the [ReadMe docs mdx page](https://docs.readme.com/main/docs/mdx.md) to understand how to write valid MDX. A good page uses components wherever they make the content easier to read: look for places each one fits, but never force one onto content that doesn't suit it. Follow [COMPONENTS.md](COMPONENTS.md) for when to use each built-in component and how to format it, and use reusable content where it fits (see below). Apply the page-type concerns below. |
There was a problem hiding this comment.
The new COMPONENTS.md is missing from claude/skills/, codex/skills/, and cursor/skills/, and their SKILL.md copies still contain the old guidance. The pull request workflow runs node scripts/sync-skills.mjs --check, which fails on missing or different copies. Plugin users also won't receive the new component instructions.
Run node scripts/sync-skills.mjs and commit the generated copies.
Knowledge Base Used: Shared agent skills
There was a problem hiding this comment.
(agent response)
Not changing this here, on purpose. This PR only changes skills/ (the canonical source). The client copies in claude/, codex/ and cursor/ have already drifted on the base branch (update-project-settings and managing-readme-docs differ, and update-project-styling is still there), so they will be synced in a separate PR. That PR will fix the sync-skills --check failure and get the new guidance to plugin users. All the other validate steps (validate-skills.mjs, claude plugin validate --strict) pass locally.
There was a problem hiding this comment.
Understood — thanks for clarifying. Given that the client-copy drift and synchronization are intentionally being handled in a separate PR, I’ll treat this as out of scope for the current change and withdraw the request here. The follow-up should run node scripts/sync-skills.mjs and include the generated copies so sync-skills --check passes and the new guidance reaches plugin users.
There was a problem hiding this comment.
(agent response)
Fixed. The PR now targets main, and I ran node scripts/sync-skills.mjs, so COMPONENTS.md, other-agents.md and the updated SKILL.md/CLIENTS.md are copied to claude/, codex/ and cursor/. c6ca4cd
There was a problem hiding this comment.
EVERYTHING FROM HERE ON ARE JUST REPEATS BTW.
So only review those above.
| | 📘 | Info | Context, FYI | | ||
| | 👍 | Success | Tips, suggestions, success states | | ||
| | 🚧 | Warning | Caution, limitations | | ||
| | ❗️ | Error | Danger, breaking changes, things that must not be skipped | |
There was a problem hiding this comment.
i think the font awesome icons are a little more professional lookin imo
There was a problem hiding this comment.
(agent response)
Agreed. Callouts now default to <Callout icon="fa-…" theme="…">, with a suggested icon for each theme. theme is always set, because it can't be inferred from a Font Awesome icon (checked against @readme/markdown). The emoji blockquote form is still documented, and agents should keep using it when the page or project already does. 008c0c5
|
|
||
| ## MDX rules | ||
|
|
||
| ReadMe pages are MDX, which is stricter than Markdown wherever HTML is involved. See [MDX](https://docs.readme.com/main/docs/mdx.md) and [Troubleshoot MDX errors](https://docs.readme.com/main/docs/rendering-errors-invalid-mdx.md). |
There was a problem hiding this comment.
I think telling the agent to follow a convention and not to mix them is good, but technically this isn't true anymore, we support standard html in jsx now
There was a problem hiding this comment.
(agent response)
Good catch. I checked @readme/markdown: the mdxish engine accepts class, string style, <br> and HTML comments, but the legacy MDX engine still rejects them, so older projects still need JSX. The rule is now: pick one convention per page, follow what the page or project already uses, and default to JSX (it works on both engines). ccfede5
2 participants
Reviewers Notes
ONLY REVIEW the first 4x files - rest are just the duplicates of those across the different plugin packages we have.
🧰 Changes
Couple of improvements:
ai-cli-runner.