-
Notifications
You must be signed in to change notification settings - Fork 4
Migrate docs automation to skills repo #1153
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
Migrate docs automation to skills repo #1153
Conversation
- Update README to point to validmind/skills for the documentation skill - Add installation instructions for Cursor Settings import - Remove local .mdc rule file (now lives in validmind/skills) [sc-14457] Co-authored-by: Cursor <cursoragent@cursor.com>
|
Pull requests must include at least one of the required labels: |
1 similar comment
|
Pull requests must include at least one of the required labels: |
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
validbeck
left a 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.
The directions in this repo's README and the skills repo README aren't accurate, even though your testing instructions in the PR more or less are ... seems kind of important!
Refer to the comments/suggestions I left — I updated the instructions based on testing / what ended up being the most seamless (less of Cursor going in circles, struggling with access to the private Skills repo even with GitHub MCP set up, writing to unnecessary files etc.) for me personally.
Can you please update the other README to have the accurate info? 🙏🏻
PR SummaryThis PR removes the existing Cursor rule and skill files used for generating or updating user documentation and updates the README to refer to the new documentation skill. Specifically, the files ".cursor/rules/create-user-documentation.mdc" and ".cursor/skills/create-user-documentation/SKILL.md" were removed, consolidating the functionality under the new approach. The README.md has been updated to instruct users to invoke the new skill (using the The changes focus on streamlining the documentation process by deprecating the older rule configuration and nudging users towards the new skill-based method, which offers enhanced clarity and a more direct way to generate user documentation in accordance with ValidMind style guidelines. Test Suggestions
|
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: 9ace085 Modify the workflow to check a different depth:
|
|
@validbeck I removed the installation instructions from this repo, they now live only in the skills repo. Can you please approve this PR so that we don't see the rule/skill pop up in our changed files on the regular? |
validbeck
left a 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.
When I follow your Cursor prompt I get the following results where Cursor has trouble accessing the repo for the subdirectories even though the repo is available locally:
I have already cloned the skills repo and have the GitHub MCP set up, so I would recommend adjusting the instructions to locate the skills subdirectories locally which I'd usually do so myself but I have no write access to skills:
| skills repo cloned | GitHub MCP setup | no write access |
|---|---|---|
![]() |
![]() |
![]() |
I'm not even able to access the Settings tab in the skills repo to change any permissions as well:
validbeck
left a 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.
As I am now able to create branches/PRs for the skills repo, issues I mentioned resolved in https://github.com/validmind/skills/pull/2 (please review & approve).



What and why?
Migrate the Cursor documentation rule to a shareable skill format hosted in the new https://github.com/validmind/skills repo.
Changes:
validmind/skillsfor the documentation skill.gitignoreto ensure we make improvements in the skills repoWhy: Skills can be shared across multiple repos via Cursor Settings, making the documentation automation available to other ValidMind repositories.
How to test
git@github.com:validmind/skills.git.Dependencies, breaking changes, and deployment notes
Release notes
Internal tooling change — migrates documentation automation from a local Cursor rule to a shared skill repository.
[sc-14457]