Skip to content

docs: sync README config example with scaffolded defaults - #14

Closed
jroell wants to merge 1 commit into
masterfrom
docs/auto-update-20260915-readme-config-sync
Closed

jroell wants to merge 1 commit into
masterfrom
docs/auto-update-20260915-readme-config-sync

Conversation

@jroell

@jroell jroell commented Sep 15, 2026

Copy link
Copy Markdown
Owner

Summary

  • sync the README.md config example with the actual gg init scaffold from src/config.ts
  • fix malformed Markdown table rows in the Pair Mode Options and Use Cases sections so they render correctly

Why

The README config snippet had drifted from the code-backed source of truth in src/config.ts. It still showed a duplicated timeoutMs key, the old 600000 timeout value, and omitted the _readme field that gg init actually writes.

Source references

  • b716fa2docs: sync defaults and benchmark notes (#5)
  • d5da97cfeat: retry-on-early-exit, test-script bootstrap, byte-level verification, model updates for terminal-bench 2.0
  • e360ddffeat: 'gg init' scaffolds .gitgang/config.json with per-repo defaults

Validation

  • reviewed the README diff against src/config.ts
  • confirmed the malformed || table rows are gone from README.md
  • no other recent significant user-facing doc gaps were found in the latest source history

Context

Also fix malformed table rows in the README so the options and use-cases tables render correctly.

Co-Authored-By: Warp <agent@warp.dev>
@jroell jroell closed this Sep 18, 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.

1 participant