Skip to content

Add Cursor command for doc impact#4558

Closed
aneta-petrova wants to merge 1 commit intotheforeman:masterfrom
aneta-petrova:cursor-determine-impact
Closed

Add Cursor command for doc impact#4558
aneta-petrova wants to merge 1 commit intotheforeman:masterfrom
aneta-petrova:cursor-determine-impact

Conversation

@aneta-petrova
Copy link
Copy Markdown
Member

@aneta-petrova aneta-petrova commented Jan 2, 2026

What changes are you introducing?

Adding a new Cursor command that should determine whether a code PR has documentation impact and also suggest changes to cover the impact.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Efficiency.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

The command is based on an instruction for Cursor that I have used a few times in the past and it worked quite nicely. I'm currently testing a modified version of the original instruction as a Cursor command and will keep this PR as a draft until I've tried it enough times to see that it provides good results. I'm sharing it early like this in case anyone else would like to start testing it too and share feedback on their results.

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • We do not accept PRs for Foreman older than 3.12.

@github-actions github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective labels Jan 2, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 2, 2026

The PR preview for d9ba7b0 is available at theforeman-foreman-documentation-preview-pr-4558.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@aneta-petrova aneta-petrova marked this pull request as ready for review March 16, 2026 20:07
@Lennonka Lennonka mentioned this pull request Mar 18, 2026
9 tasks
@Lennonka
Copy link
Copy Markdown
Contributor

Lennonka commented Mar 18, 2026

Works quite nicely.
Perhaps you might add some instructions regarding the style? Like one sentence per line, e.g. make it read a README or something?

Also, please, rebase so that the diff is accurate.

@aneta-petrova
Copy link
Copy Markdown
Member Author

Works quite nicely. Perhaps you might add some instructions regarding the style? Like one sentence per line, e.g. make it read a README or something?

Thanks for giving it a try!

I think that rather than recording repo-specific rules in this command file (and by extension every other command and skill file), it would be best if we recorded these rules somewhere where Cursor/Claude/anything else reads it every time they make a change. So yes, let's look into that -- not in this PR but perhaps something like a separate skill file that loads the readme, contribution guidelines, etc.? We should totally explore that later.

Also, please, rebase so that the diff is accurate.

👍

@Lennonka
Copy link
Copy Markdown
Contributor

Lennonka commented Mar 30, 2026

2 suggestions:

  • command -> skill
  • placed in .claude/ instead of .cursor/ because Cursor reads skills from the Claude folder but not vice versa

@Lennonka Lennonka added the Waiting on contributor Requires an action from the author label Mar 30, 2026
@aneta-petrova
Copy link
Copy Markdown
Member Author

After further discussion downstream, the preference is to use downstream tools that also involve the JIRA instance available there. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective Not yet reviewed Waiting on contributor Requires an action from the author

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants