Skip to content

docs: add CHANGELOG entries for #43/#44 and sync demo /help snapshot - #45

Merged
shauryagangrade merged 1 commit into
shauryagangrade:mainfrom
aryansk:docs/followup-changelog-demo
Aug 14, 2026
Merged

docs: add CHANGELOG entries for #43/#44 and sync demo /help snapshot#45
shauryagangrade merged 1 commit into
shauryagangrade:mainfrom
aryansk:docs/followup-changelog-demo

Conversation

@aryansk

@aryansk aryansk commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Problem

Follow-up to the review comments on the two GCode PRs merged today:

  • #44 — the review asked
    for demo/make_demo.py to stop hardcoding the old flat /help snapshot and
    instead mirror the categorized /help output.

Change

  • demo/make_demo.py: the /help demo block now mirrors the categorized
    output from _print_help in gcode/cli.py, including /ollama, /pull,
    /setup, and /diff, which were missing from the flat snapshot, plus the
    "Any other input is sent to the agent." line.

This branch intentionally touches only demo/make_demo.py — the CHANGELOG
entries for #43/#44 already landed on main at merge time.

Why this approach

Keeps the recorded demo in sync with the real /help output. Note the demo
pipeline has since migrated to vhs (vhs demo/demo.tapedocs/demo.gif,
documented in the README's "Demo GIF" section); make_demo.py is a legacy
self-contained renderer kept because it reproduces the exact Rich markup of
_print_help, and its docstring now says so.

Testing

uv run python -m compileall -q gcode demo      # OK
uv run ruff check .                            # All checks passed

The demo /help markup was rendered through Rich to confirm it parses and
produces the categorized layout (verified by the maintainer).

Documentation and release impact

@shauryagangrade

Copy link
Copy Markdown
Owner

Thanks for the follow-up! Most of this already landed on main, so this PR now conflicts and should be slimmed down. Verified against current main:

1. The CHANGELOG half is redundant — please drop it.
Both entries already exist on main (added at merge time):

  • CHANGELOG.mdUnreleased > Changed: "/help command listing grouped by category (General, Model, Session, Git)…"
  • CHANGELOG.mdUnreleased > Fixed: "execute_bash no longer hangs or crashes when its approval prompt runs in a non-interactive environment…"

A rebase onto main fails with a conflict in CHANGELOG.md for exactly this reason. Keep only the demo/make_demo.py change.

2. The make_demo.py change is still useful, but conflicts too.
main already has a partial categorized /help snapshot (commit 3e2df7f) that's missing /ollama, /pull, /setup, /diff, and the "Any other input is sent to the agent." line. Your version completes it and matches _print_help exactly — I rendered it through Rich and it parses cleanly. After rebasing, resolve the conflict by keeping your full version.

3. Stale premises in the description (worth updating).

  • demo/demo.tape is no longer an asciinema recording: the demo pipeline was migrated to vhs (vhs demo/demo.tapedocs/demo.gif, documented in the README's new "Demo GIF" section). It can now be regenerated headless.
  • make_demo.py is legacy after that migration, and its docstring still claims it outputs docs/demo.gif — which is now vhs-generated. Consider updating the docstring or dropping the script.

Per maintainer feedback on shauryagangrade#45: keep only the make_demo.py change.
The snapshot now matches _print_help (adds /ollama, /pull, /setup,
/diff, and the 'Any other input' line); CHANGELOG entries were already
merged to main, and the stale docstring is updated to note the vhs
migration.
@aryansk
aryansk force-pushed the docs/followup-changelog-demo branch from ef131c0 to d19b42b Compare August 14, 2026 15:07
@aryansk

aryansk commented Aug 14, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the detailed review — all three points addressed:

  1. CHANGELOG dropped. The branch now touches only demo/make_demo.py.
  2. make_demo.py kept in full. Rebased onto current main and resolved the
    conflict by keeping the complete /help snapshot (/ollama, /pull,
    /setup, /diff, and the "Any other input is sent to the agent." line).
  3. Description updated and the script docstring now notes the vhs migration
    (vhs demo/demo.tapedocs/demo.gif) and that this renderer is kept for
    verifying /help snapshot changes against the exact Rich markup.

Branch now merges cleanly against main.

@shauryagangrade
shauryagangrade marked this pull request as ready for review August 14, 2026 15:13
@shauryagangrade
shauryagangrade merged commit 9068e69 into shauryagangrade:main Aug 14, 2026
6 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.

2 participants