Skip to content

docs: add organization Pages while retaining repository docs - #5

Merged
rockyshi1993 merged 4 commits into
mainfrom
codex/docs-org-pages
Oct 10, 2026
Merged

rockyshi1993 merged 4 commits into
mainfrom
codex/docs-org-pages

Conversation

@rockyshi1993

@rockyshi1993 rockyshi1993 commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Keep documentation publishing at https://devcodex-labs.github.io/vextjs/ and add a publisher for https://vextjs.github.io/ from the same trusted source CI SHA.

  • Build and validate /vextjs/ and / separately, with distinct artifacts and matching canonical/machine-resource URLs.
  • Publish the existing source site through the official Pages artifact and OIDC workflow. Publish the organization site through a dedicated writable SSH Deploy Key to vextjs/vextjs.github.io.
  • Until VEXT_DOCS_DEPLOY_KEY is configured, skip organization publication with a notice and continue publishing the source site. Once configured, organization push failures also remain independent of source-site deployment. Both builds must pass before deployment starts.
  • Recheck the current main SHA before deployment queues and again before publishing. Preserve target Git history, remove obsolete generated files, skip unchanged output, and reject non-fast-forward pushes.
  • Retain existing package, CLI and documentation entry URLs; add the organization URL to README. Document both publishers in Chinese and English.

Validation: framework build, typecheck, documentation source and CI contracts, 281 cluster/adapter/application/workflow regressions, actionlint, formatting, and 12 local deployment behavior groups passed. The combined organization build passed the complete publishing gate (36 source/rule tests, 23 integration tests, 12 rendered-contract tests); its 182 manifest entries, 185 HTML pages and 1,280 asset references match the root base path. Full remote CI passed all 16 jobs for 3b852bccdcce122bdc7d0e0a44eec347ad79ac4f.

Organization first-time setup remains pending: initialize public vextjs/vextjs.github.io with main, configure Pages for main /, add a writable Deploy Key there, and store the private key as this source repository's VEXT_DOCS_DEPLOY_KEY. Until then the source Pages continues publishing and the organization publisher is skipped.

@rockyshi1993 rockyshi1993 changed the title docs: publish documentation at vextjs.github.io docs: add organization Pages while retaining repository docs Oct 10, 2026
@rockyshi1993
rockyshi1993 marked this pull request as ready for review October 10, 2026 02:40
@rockyshi1993
rockyshi1993 merged commit f56c638 into main Oct 10, 2026
16 checks passed
@rockyshi1993
rockyshi1993 deleted the codex/docs-org-pages branch October 10, 2026 02:50
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