Skip to content

docs: clean up README instructions#146

Open
partyplatter08-lab wants to merge 1 commit into
zigcBenx:masterfrom
partyplatter08-lab:partyplatter08-lab/bounty-114
Open

docs: clean up README instructions#146
partyplatter08-lab wants to merge 1 commit into
zigcBenx:masterfrom
partyplatter08-lab:partyplatter08-lab/bounty-114

Conversation

@partyplatter08-lab
Copy link
Copy Markdown

Summary

  • Refresh the README setup flow with dependency installation, config copying, required settings, and alias instructions.
  • Document the current GitHappens command surface for issue and merge request creation, project selection, metadata flags, review, AI review, summaries, incident reports, and deployment lookup.
  • Fix README typos, the config filename reference, the malformed auto-merge example, and the duplicated production deployment section.

Validation

  • git diff --check HEAD
  • npx --yes markdownlint-cli --disable MD013 MD033 MD041 -- README.md
  • python3 -c "import py_compile; py_compile.compile('gitHappens.py', cfile='/tmp/githappens.pyc', doraise=True); py_compile.compile('ai_code_review.py', cfile='/tmp/ai_code_review.pyc', doraise=True)"

Fixes #114

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