Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Ship documentation URLs with lint rules #166

Closed
2 tasks
nikku opened this issue Feb 17, 2025 · 1 comment · Fixed by #167
Closed
2 tasks

Ship documentation URLs with lint rules #166

nikku opened this issue Feb 17, 2025 · 1 comment · Fixed by #167
Assignees
@nikku
Labels
enhancement New feature or request

Comments

@nikku
Copy link
Member

nikku commented Feb 17, 2025

Is your feature request related to a problem? Please describe

Via #165 we support attaching meta, including documentation URLs, to error reports. How to deal with our own documentation?

Describe the solution you'd like

  • Embed documentation URLs for built-in rules within the rule
  • (Users can customize / decide not to display / transform) documentation as they see fit

Describe alternatives you've considered

Make it user-land responsibility to feature documentation.

Additional context

Related to https://github.com/bpmn-io/bpmnlint/tree/main/docs/rules.
@nikku nikku added the enhancement New feature or request label Feb 17, 2025
@nikku nikku self-assigned this Feb 17, 2025
@nikku nikku added the ready Ready to be worked on label Feb 17, 2025
@barmac
Copy link
Member

barmac commented Feb 17, 2025

I think it makes sense to ship the documentation links with the rules.

nikku added a commit that referenced this issue Feb 17, 2025
@nikku
feat(rules): attach documentation URL
b74c8c2 
Closes #166
nikku added a commit that referenced this issue Feb 17, 2025
@nikku
feat(rules): attach documentation URL
c93f1a5 
Closes #166
nikku added a commit that referenced this issue Feb 17, 2025
@nikku
feat(rules): attach documentation URL
a4c7309 
Closes #166
@nikku nikku mentioned this issue Feb 17, 2025
Merged
4 tasks
@bpmn-io-tasks bpmn-io-tasks bot added needs review Review pending and removed ready Ready to be worked on labels Feb 17, 2025
nikku added a commit that referenced this issue Feb 17, 2025
@nikku
feat(rules): attach documentation URL
4f67e9d 
Closes #166
nikku added a commit that referenced this issue Feb 17, 2025
@nikku
feat(rules): attach documentation URL
49db7f5 
Closes #166
barmac pushed a commit that referenced this issue Feb 18, 2025
@nikku @barmac
feat(rules): attach documentation URL
52258b8 
Closes #166
@bpmn-io-tasks bpmn-io-tasks bot removed the needs review Review pending label Feb 18, 2025
@nikku nikku mentioned this issue Feb 18, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nikku nikku

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add documentation URL to built-in rules bpmn-io/bpmnlint
2 participants
@nikku @barmac