Skip to content

Document transactional generation and release workflows - #39

Open
lynnswap wants to merge 18 commits into
codex/phk-runtime-lifecyclefrom
codex/phk-docs
Open

Document transactional generation and release workflows#39
lynnswap wants to merge 18 commits into
codex/phk-runtime-lifecyclefrom
codex/phk-docs

Conversation

@lynnswap

@lynnswap lynnswap commented Aug 9, 2026

Copy link
Copy Markdown
Owner

Purpose

Make the implemented generation, migration, installation, and release contracts explicit for users and maintainers.

Changes

  • Document the single-command workflow, resume and fresh behavior, immutable output layout, and legacy-output migration in English and Japanese.
  • Document the opaque source storage identifier as the sole durable namespace, separate from user-facing source labels.
  • Document release cohorts, source-install provenance, interrupted installer recovery, and the draft-release workflow.
  • Clarify that installer recovery spans the durable intent file and filesystem mutations, with best-effort immediate rollback and next-install recovery.
  • Document the combined legacy-migration confirmation and the canonical <output-base>/.state/<source-storage-id>/generation.sqlite path.
  • Distinguish historical test-count snapshots from the current acceptance gates.
  • Update the architecture contract with causal state ordering, atomic filesystem primitives, retention rules, signal ownership, and content-addressed cohort identity.

Testing

  • Final-stack swift test (310 tests in 32 suites).
  • Documentation command and cross-build examples exercised by the final validation.
  • git diff --check.

@lynnswap lynnswap changed the title codex/phk docs Document transactional generation and release workflows Aug 9, 2026
@lynnswap
lynnswap marked this pull request as ready for review August 9, 2026 21:59

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4778218f61

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread Docs/privateheaderkit-rearchitecture-2026-07.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated

@lynnswap lynnswap left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. What shall we delve into next?

Reviewed commit: d502495819

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@lynnswap lynnswap left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Swish!

Reviewed commit: 37c93df910

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

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