Skip to content

Update README for accuracy and add mermaid architecture diagram#19

Merged
darkiris4 merged 1 commit intomainfrom
docs/update-readme
Feb 9, 2026
Merged

Update README for accuracy and add mermaid architecture diagram#19
darkiris4 merged 1 commit intomainfrom
docs/update-readme

Conversation

@darkiris4
Copy link
Owner

  • Replace ASCII placeholder with mermaid flowchart from User Guide
  • Fix Tech Stack: openscap-py → oscap-ssh, MUI X Pro → MUI X, remove nonexistent fastapi-websocket package
  • Update project structure tree to match actual repo layout
  • Correct SSH discovery to mention both ~/.ssh/config and known_hosts
  • Remove "Login (optional basic auth)" claim (no auth implemented)
  • Update Contributing: Black → Ruff, remove Jest reference
  • Align env var docs with .env.example, separate optional vars
  • Bump prerequisite versions to Python 3.11+ and Node.js 20+

Summary

Describe what changed and why.

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Refactor

Testing

  • pytest backend/tests/
  • npm run build (from frontend/)
  • Not run (explain why)

Checklist

  • I have linked relevant issues
  • I have added/updated tests where appropriate
  • I have updated documentation where needed
  • I have not included secrets or credentials

- Replace ASCII placeholder with mermaid flowchart from User Guide
- Fix Tech Stack: openscap-py → oscap-ssh, MUI X Pro → MUI X, remove
  nonexistent fastapi-websocket package
- Update project structure tree to match actual repo layout
- Correct SSH discovery to mention both ~/.ssh/config and known_hosts
- Remove "Login (optional basic auth)" claim (no auth implemented)
- Update Contributing: Black → Ruff, remove Jest reference
- Align env var docs with .env.example, separate optional vars
- Bump prerequisite versions to Python 3.11+ and Node.js 20+

Co-authored-by: Cursor <cursoragent@cursor.com>
@darkiris4 darkiris4 merged commit 02847d9 into main Feb 9, 2026
2 checks passed
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