Skip to content

docs: align Zi contribution guidance with protected main - #942

Merged
ss-o merged 1 commit into
mainfrom
docs/zi-main-contribution-771
Oct 9, 2026
Merged

ss-o merged 1 commit into
mainfrom
docs/zi-main-contribution-771

Conversation

@ss-o

@ss-o ss-o commented Oct 9, 2026

Copy link
Copy Markdown
Member

Summary

Zi now accepts ordinary contributions on protected main after the verified zi#631 cutover. Update the getting-started and Zi contribution pages to describe current-main topics, full qualification, native issue closure and separately authorized signed milestones. Correct the source/test examples and retain the existing stable-branch-promotion anchor so old links still reach its historical context.

Update two package pages whose next-only legacy-rejection warning is stale: the current main reader still accepts legacy zplugin-ices only when zi-ices is absent, while new maintained definitions require zi-ices. The parsing regression and pinned example manifest contents verify that distinction.

Refs z-shell/.github#771 and zi#628. The canonical organization policy synchronization is z-shell/.github#778.

Verification

  • Four English source pages only; no dependencies, lockfile, localization, workflow or label changes. Both Crowdin workflows remain disabled, and the changed community/ecosystem roots are not mapped for upload.
  • Frontmatter validation, targeted Trunk, English production build and code-fence tests pass. Built links/artifacts cover 84 artifacts and 78 documents; LLM corpus tests and all six evaluation cases pass.
  • Rendered output contains the retained stable-branch-promotion heading ID and its table-of-contents links. The anchor uses Docusaurus's supported MDX comment syntax.
  • Zi's package-reader fallback is checked against source and its package-manifest parsing regression; pinned GitHub example manifests still use the legacy key. New-definition guidance remains on the versioned contract's zi-ices key.
  • Delivered Zi main 22b6da908579e6e8143a0abe02e6da14e7b4d5b8 has passed all 21 full-qualification jobs, separate push workflows, fresh startup and existing-consumer update/fetch-failure preservation/retry. Protected main and signed-milestone settings were read back before the normal merge.

Agent handoff

  • Status: Documentation synchronization ready for current-head hosted checks and review.
  • Blockers: Applicable Class 1 review of record before the authorized merge; a configured Copilot request must register, or the maintainer must explicitly elect the ADR-0035 exception for this exact head and obtain a separate read-only review.
  • Remaining coordinated work: Private tracking/generation and separately authorized remote next retirement remain under parent build(deps-dev): bump the linting group with 2 updates #771. Retain historical tags, ancestry and unmerged topic work. No tag, release or localization upload is part of this change.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying zsh with  Cloudflare Pages  Cloudflare Pages

Latest commit: 57c186f
Status: ✅  Deploy successful!
Preview URL: https://9b0b939a.zsh.pages.dev
Branch Preview URL: https://docs-zi-main-contribution-77.zsh.pages.dev

View logs

@ss-o ss-o left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fallback review under ADR-0026: Copilot request not registered on 57c186f

Findings and election

No actionable findings in the complete four-page diff at head 57c186fda14e0df21f3c45ab0046d0266a53ace4, base and merge base 567eec4ece8419f578146dd5d148eac710457f48. The maintainer explicitly elected ADR35 for this PR and full head and confirmed that no second human is available. The owner review and an additional read-only review in a separate headless session both inspected the same unchanged head.

Note

This is the elected sole-maintainer exception. Additional automated scrutiny is not a second human or proof of independent judgment, and this review does not itself authorize deployment.

Request history

The configured Copilot request was made once on this ready head at 2026-10-09 19:19:17 UTC. The requested-reviewers endpoint returned HTTP200 with an empty requested reviewer list. Fully paginated timeline and review read-backs before and after the request showed no registered Copilot request event or review. Cause remains unconfirmed; quota exhaustion is not established and no repeated request was made.

Validation and separate review

  • Owner checks passed: English production build, MDX frontmatter, targeted Trunk on all four pages, code-fence and corpus tests, generated corpus/link validation and six evaluation cases. The old stable-branch-promotion anchor remains in rendered HTML. Current-head hosted Trunk, both CodeQL analysis families, corpus, routing and policy checks and Cloudflare preview all passed.
  • Separate session: Reviewed every changed hunk, contributor contract, metadata-reader precedence, source ownership, localization boundary, internal links and deployment/supply-chain impact. It found no actionable defect and changed no source. Direct frontmatter and all six code-fence tests passed; existing production HTML retained the old anchor and all 111 internal article links checked resolved. Full build, Trunk and external-state refresh were deliberately left to the owner.
  • Separate-session limits: Its pnpm launchers failed before running scripts with unable to open database file. The exact Node commands declared in package.json passed instead. The delegation wrapper recorded an incomplete task outcome despite the completed review report, so a successful delegation is not claimed. The owner read the complete report, verified clean source/exact revisions and repeated the declared Node checks and all 111 built-link checks successfully. The launcher/reporting observations are recorded separately and do not establish a documentation defect.
Checklist verdicts and evidence
  • Contribution contract: PASS. Ordinary Zi topics and hotfixes branch from and target protected main under accepted ADR39. Source entry point zi.zsh, native syntax check and focused test examples match delivered source guidance. Native default-branch issue closure and separately authorized signed milestones are distinguished; no example publishes a milestone or changes the consumer channel.
  • Package compatibility: PASS. The actual native-Zsh reader selects zi-ices first and uses zplugin-ices only when the current key is absent. The parsing regression and pinned manifest examples match that behavior. The versioned contract for new package definitions still requires zi-ices; existing fallback is described accurately without promising new legacy declarations.
  • Documentation ownership: PASS. Contributor pages remain under community and package catalog pages under ecosystem. MDX frontmatter, imported assets, categories, code fences and retained anchors are consistent. No generated instruction file or shared source is hand-edited.
  • Supply chain and publication: PASS within scope. Only four English MDX sources change. No dependencies, workflows, secrets, deployment configuration or new network behavior change. Actual Zi signed main 22b6da90 passed all 21 qualification jobs and startup/update recovery checks before these assertions were published. Those live source/settings facts were verified by the owner and supplied as frozen observations to the separate session.
  • Localization: PASS within scope. Labels and translations are unchanged. The changed community/ecosystem page bodies are outside current upload mappings; both Crowdin workflows remain disabled. No upload or workflow enablement is claimed.
  • Review gates: PASS. Head is unchanged, all required checks are successful and fully paginated review threads contain no unresolved findings. Existing ruleset settings remain intact. The review exception changes no approval count or bypass actor and permits no administrative merge.

Recovery and remaining proof

Normal protected squash is the permitted merge method. Verify successful build and deployment on the exact merged-main commit before declaring production delivery. Existing HTML and successful PR preview are candidate evidence, not merged-main evidence. If a defect appears, use a signed, reviewed corrective or revert PR through protected main and validate its resulting main build before any separately authorized publication. Organization #778 is delivered; private tracking and separately scoped next retirement remain under #771 and zi#628. No release, tag, cleanup or account change is authorized by this review.

@ss-o
ss-o merged commit bcd13ed into main Oct 9, 2026
12 checks passed
@ss-o
ss-o deleted the docs/zi-main-contribution-771 branch October 9, 2026 21:21
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