Skip to content

docs: clean up README setup guide#156

Open
CalLeeLQY wants to merge 1 commit into
zigcBenx:masterfrom
CalLeeLQY:codex/docs-svit-openpledge
Open

docs: clean up README setup guide#156
CalLeeLQY wants to merge 1 commit into
zigcBenx:masterfrom
CalLeeLQY:codex/docs-svit-openpledge

Conversation

@CalLeeLQY
Copy link
Copy Markdown

Fixes #114

Summary

  • Correct README setup prerequisites and configuration paths.
  • Replace individual dependency install commands with pip install -r requirements.txt.
  • Fix broken command examples, JSON fences, typoed headings, and duplicate deployment documentation.
  • Clean up Markdown formatting so the README passes markdownlint with the project's existing disabled rules.

Verification

  • git diff --check
  • python3 -m py_compile gitHappens.py ai_code_review.py
  • npx --yes markdownlint-cli --disable MD013 MD033 MD041 -- README.md

@CalLeeLQY CalLeeLQY mentioned this pull request May 15, 2026
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.

Fix docs, Svit

1 participant