Skip to content

docs: make the first-run experience simple and self-explanatory - #6

Merged
megamen32 merged 1 commit into
mainfrom
docs/simple-first-run
Jul 13, 2026
Merged

megamen32 merged 1 commit into
mainfrom
docs/simple-first-run

Conversation

@megamen32

Copy link
Copy Markdown
Owner

Goal

Make the tool understandable without reading documentation first.

Changes

  • reduces each main README from ~260 lines to 72
  • quick start is only pip install git-private2public + git-private2public
  • presents three beginner actions: check, publish, diagnose
  • moves regex, allowlists, CI JSON, hooks, tags, YAML and implementation details to Advanced docs
  • simplifies top-level CLI help and labels hook/guard as advanced
  • makes interactive init detect the private origin and ask only for the public target
  • keeps deterministic template behavior in non-interactive/CI sessions
  • corrects stale Advanced documentation about built-in scans and hook chaining

Validation

  • 61 tests pass
  • warnings treated as errors
  • python -m py_compile passes
  • git diff --check passes
  • interactive and non-interactive init flows tested
  • real pseudo-terminal init verified against a Git repo with an origin remote

@megamen32
megamen32 merged commit da8e70b into main Jul 13, 2026
2 checks passed
@megamen32
megamen32 deleted the docs/simple-first-run branch July 13, 2026 15:17
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