Skip to content

docs: refresh README with mermaid diagram and improved layout#51

Merged
MattDevy merged 8 commits into
mainfrom
docs/readme-refresh
Apr 6, 2026
Merged

docs: refresh README with mermaid diagram and improved layout#51
MattDevy merged 8 commits into
mainfrom
docs/readme-refresh

Conversation

@MattDevy
Copy link
Copy Markdown
Owner

@MattDevy MattDevy commented Apr 6, 2026

Summary

  • Replaces the ASCII flow diagram with a Mermaid flowchart LR showing the session/analyzer data flow
  • Adds CI, npm, and license badges
  • Converts prose-heavy sections to tables (requirements, confidence scoring, safety features, quality tiers, graduation targets, config reference)
  • Tightens the overall structure with --- section dividers and cleaner headings
  • No content removed — same information, better visual hierarchy

BEGIN_COMMIT_OVERRIDE
fix: refresh docs
END_COMMIT_OVERRIDE

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 6, 2026

⚠️MegaLinter analysis: Success with warnings

Descriptor Linter Files Fixed Errors Warnings Elapsed time
⚠️ MARKDOWN markdownlint 1 2 0 0.63s
✅ REPOSITORY gitleaks yes no no 0.85s
✅ REPOSITORY git_diff yes no no 0.34s

Detailed Issues

⚠️ MARKDOWN / markdownlint - 2 errors
README.md:267 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
README.md:327 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]

See detailed reports in MegaLinter artifacts
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@MattDevy MattDevy merged commit b7cf275 into main Apr 6, 2026
2 checks passed
@MattDevy MattDevy deleted the docs/readme-refresh branch April 6, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant