Skip to content

[codex] Polish skill-only handoff docs#6

Merged
AniruddhaHumane merged 3 commits into
masterfrom
codex/skill-branch-docs
Apr 19, 2026
Merged

[codex] Polish skill-only handoff docs#6
AniruddhaHumane merged 3 commits into
masterfrom
codex/skill-branch-docs

Conversation

@AniruddhaHumane
Copy link
Copy Markdown
Owner

What changed

  • Keeps master focused on the skill-only distribution surface: skills/, install.sh, README, and lightweight GitHub metadata.
  • Preserves the previous Python package and internal planning docs on the python-package-docs branch.
  • Rewrites the README as a clearer visitor-facing guide that explains the purpose, common use cases, workflow, storage layout, install modes, and design principles.
  • Adds a bash installer for Codex and Claude skill installation, with copy and symlink modes.
  • Replaces Python CI with shell and installer smoke checks.

Why

The skills do not depend on the Python package at runtime. This makes master easier for visitors to understand: it now presents portable-handoff as a compact skill distribution repo rather than a Python library.

Validation

  • bash -n install.sh
  • ./install.sh both --home "$tmp" --mode copy
  • verified Codex and Claude skill files were installed in the temporary home
  • ./install.sh codex --home "$tmp" --mode symlink
  • verified both Codex skill installs were symlinks
  • git show --check --stat --oneline HEAD

Notes

gh auth status reports an invalid local GitHub CLI token, so the branch was pushed with git and this PR was opened with the GitHub connector.

Add a dedicated handoff-install command that installs the handoff and get-handoff skill folders into Codex or Claude. Local checkout installs default to symlinks for iterative testing, while packaged installs copy bundled skill assets.

Constraint: Runtime handoff UX remains skill-first; CLI is only for installation
Rejected: Reintroduce handoff runtime commands | would blur the approved /handoff and /get-handoff product surface
Confidence: high
Scope-risk: narrow
Directive: Keep handoff-install focused on skill installation only
Tested: python -m unittest discover -s tests -p 'test_install.py' -v
Tested: PYTHONPATH=src python -m unittest discover -s tests -v
Tested: python -m compileall src tests
Tested: pip --prefix smoke install followed by handoff-install codex --mode copy
Not-tested: Published package marketplace installation
The skill files are the current product surface, so master no longer needs to carry the Python package, library tests, or internal superpowers planning docs. Those artifacts remain available on the python-package-docs branch while master ships a small bash installer and shell-only CI validation.

Constraint: Skills execute as agent instructions and do not depend on the Python package
Rejected: Keep Python installer on master | it makes the public branch look like a Python package when the intended surface is skill installation
Confidence: high
Scope-risk: moderate
Reversibility: clean
Directive: Keep Python/library experiments on python-package-docs or another feature branch unless master intentionally becomes a package again
Tested: bash -n install.sh; copy install into temporary Codex and Claude homes; symlink install into temporary Codex home; skill metadata grep checks; git diff --check
Not-tested: Real Codex or Claude runtime reload after install
The repository now presents portable-handoff as a skill-first handoff protocol, so the README needs to explain the purpose, use cases, workflow, storage model, and install modes before a visitor has to inspect the skill files.

Constraint: Master intentionally ships only skills plus a shell installer
Rejected: Add a separate docs site | too much surface for a compact skill distribution branch
Confidence: high
Scope-risk: narrow
Reversibility: clean
Directive: Keep the README aligned with the skill-only master branch unless Python packaging returns to master
Tested: bash -n install.sh; copy install into temporary Codex and Claude homes; symlink install into temporary Codex home; git diff --check
Not-tested: Rendered GitHub markdown in browser
@AniruddhaHumane AniruddhaHumane marked this pull request as ready for review April 19, 2026 02:17
@AniruddhaHumane AniruddhaHumane merged commit d382269 into master Apr 19, 2026
1 check passed
@AniruddhaHumane AniruddhaHumane deleted the codex/skill-branch-docs branch April 19, 2026 02: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