Skip to content

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Feb 5, 2026

What and why?

Migrate the Cursor documentation rule to a shareable skill format hosted in the new https://github.com/validmind/skills repo.

Changes:

  • Update README to point to validmind/skills for the documentation skill
  • Add installation instructions for Cursor Settings remote rule import
  • Remove local rule and skill (now lives in validmind/skills)
  • Add local rules and skills to the .gitignore to ensure we make improvements in the skills repo

Why: Skills can be shared across multiple repos via Cursor Settings, making the documentation automation available to other ValidMind repositories.

How to test

  1. Clone git@github.com:validmind/skills.git.
  2. In the documentation repo, install the skill via Cursor Settings → Rules, Skills, Subagents → New Skill → "Import the skill from https://github.com/validmind/skills".
  3. Let Cursor do its thing.
  4. Verify the skill appears in Cursor Settings under Skills but that it doesn't show up under changed files for git.
  5. Test with a prompt like "Create documentation for feature X".

Dependencies, breaking changes, and deployment notes

  • Depends on: validmind/skills PR (skills repo changes)
  • No breaking changes — the skill functionality is identical to the previous rule

Release notes

Internal tooling change — migrates documentation automation from a local Cursor rule to a shared skill repository.

[sc-14457]

- 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>
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers added the internal Not to be externalized in the release notes label Feb 5, 2026
@claude
Copy link

claude bot commented Feb 5, 2026

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@nrichers nrichers requested a review from validbeck February 5, 2026 19:47
Copy link
Collaborator

@validbeck validbeck left a 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!

Image

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? 🙏🏻

nrichers and others added 6 commits February 6, 2026 16:17
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
…github.com:validmind/documentation into nrichers/sc-14457/migrate-docs-automation-to-skill
@github-actions
Copy link
Contributor

github-actions bot commented Feb 7, 2026

PR Summary

This 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 /create-user-documentation command) instead of the old rule-based workflow.

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

  • Verify that invoking the new /create-user-documentation skill in a Cursor chat produces the expected prompts and behavior.
  • Confirm that the README correctly explains the usage of the new skill and that all references to the old rule are removed.
  • Ensure that the removal of the old rule and skill files does not impact any other functionality in the repository.
  • Test the integration to check that the new skill correctly fetches the required context from Shortcut, GitHub, and attached screenshots.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 7, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions
Copy link
Contributor

github-actions bot commented Feb 7, 2026

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: 9ace085

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.65 1.00 0.82
/get-started/get-started.html 0.85 0.69 1.00 0.73
/guide/guides.html 0.85 0.69 1.00 0.82
/index.html 0.93 0.66 1.00 0.82
/releases/all-releases.html 0.86 0.68 1.00 0.73
/support/support.html 0.91 0.65 1.00 0.82
/training/training.html 0.85 0.67 0.96 0.73

@nrichers nrichers requested a review from validbeck February 7, 2026 01:16
@nrichers
Copy link
Collaborator Author

nrichers commented Feb 7, 2026

@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?

Copy link
Collaborator

@validbeck validbeck left a 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:

Screenshot 2026-02-09 at 11 17 48 AM

Cursor transcript

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
Image Image Image

I'm not even able to access the Settings tab in the skills repo to change any permissions as well:

Image

@validbeck validbeck self-requested a review February 9, 2026 22:37
Copy link
Collaborator

@validbeck validbeck left a 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).

@nrichers nrichers merged commit 8dd7f98 into main Feb 10, 2026
13 checks passed
@nrichers nrichers deleted the nrichers/sc-14457/migrate-docs-automation-to-skill branch February 10, 2026 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants