Skip to content

docs: improve validation rule reference using mermaid flowchart#1097

Open
csmdg7 wants to merge 1 commit into
utksh1:mainfrom
csmdg7:feature/issue-863
Open

docs: improve validation rule reference using mermaid flowchart#1097
csmdg7 wants to merge 1 commit into
utksh1:mainfrom
csmdg7:feature/issue-863

Conversation

@csmdg7

@csmdg7 csmdg7 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Description

This PR successfully resolves the fragmentation of plugin metadata validation rules by appending a dedicated "Common Validation Mistakes & Troubleshooting Matrix" to the bottom of docs/plugin-validation.md.

Key additions:

  • A concrete troubleshooting reference matrix linking specific syntax and schema mismatches (e.g., mixing integer ranges on string fields or unescaped regex characters) to actionable resolution steps.
  • A visual execution-order reference powered by an inline Mermaid flowchart to map out exactly how the frontend validation engine prioritizes validation_type presets over custom pattern regex keys.

These updates fulfill all criteria for issue #863 by eliminating ambiguity for upcoming plugin contributors without modifying surrounding tracking configurations.

Related Issues

Closes #863

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

How Has This Been Tested?

  • Staged locally and verified the visual integrity of the newly implemented Mermaid script using the Markdown rendering preview tool inside VS Code.
  • Cross-checked error mappings directly against the core schema expectations described in the pre-existing specification tables.

Checklist

  • My code follows the code style of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.

@csmdg7 csmdg7 force-pushed the feature/issue-863 branch from 3b2974d to d56e189 Compare June 19, 2026 18:12
@csmdg7

csmdg7 commented Jun 19, 2026

Copy link
Copy Markdown
Contributor Author

Hi @utksh1,

I have updated the document, but the CRLF format doesn't get approved by the bot even though I had chosen the LF format; Otherwise, I have updated the other requirements. Please do let me know if any changes are required.

Thank you!

@utksh1 utksh1 added level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label area:docs Documentation or contributor guide work labels Jun 20, 2026

@utksh1 utksh1 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes. The current run fails formatting-hygiene. Please fix formatting and ensure the Mermaid addition renders cleanly in the plugin validation docs.

@csmdg7 csmdg7 force-pushed the feature/issue-863 branch 2 times, most recently from ed7b537 to 389039f Compare June 22, 2026 11:33
@csmdg7 csmdg7 force-pushed the feature/issue-863 branch from 389039f to aeeb8f9 Compare June 22, 2026 11:38
@csmdg7

csmdg7 commented Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

Hi @utksh1,

I have thoroughly debugged the line-ending discrepancies. The formatting-hygiene failures were caused by local Git configuration defaults automatically injecting Windows CRLF line endings during staging.

I have now explicitly forced core.autocrlf false and core.eol lf parameters across the local environment repository settings, stripped the cache tracking, and force-pushed the file with strict Unix LF line endings.

The file and the Mermaid diagram should now render correctly. Thank you!

image

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

Labels

area:docs Documentation or contributor guide work level:beginner 20 pts difficulty label for small beginner-friendly PRs type:docs Documentation work category bonus label

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Add plugin validation troubleshooting matrix

2 participants