Skip to content

docs: refresh README setup and command reference#131

Open
Sphinx-8 wants to merge 1 commit into
zigcBenx:masterfrom
Sphinx-8:docs/refresh-readme-command-reference
Open

docs: refresh README setup and command reference#131
Sphinx-8 wants to merge 1 commit into
zigcBenx:masterfrom
Sphinx-8:docs/refresh-readme-command-reference

Conversation

@Sphinx-8

Copy link
Copy Markdown

Summary

  • Rework the README setup flow with dependency installation, config copy steps, required config values, and a non-conflicting alias example.
  • Document the source-verified GitHappens command surface for issue creation, project selection, metadata flags, review, AI review, reports, summaries, and last production deploy lookup.
  • Clarify template usage, projectIds, strict JSON comment removal, troubleshooting, and OpenPledge/GitLab links.

Fixes #114

Validation

  • npx --yes markdownlint-cli --disable MD013 MD033 MD041 -- README.md
  • git diff --check
  • PYTHONDONTWRITEBYTECODE=1 python3 -m py_compile gitHappens.py ai_code_review.py
  • Parsed README JSON examples locally.

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