Skip to content

Restructure docs for Bridgetown migration; add AGENTS runbook and reference docs#43

Closed
blackopsrepl wants to merge 1 commit into
mainfrom
codex/migrate-solverforge.github.io-to-docs-folder
Closed

Restructure docs for Bridgetown migration; add AGENTS runbook and reference docs#43
blackopsrepl wants to merge 1 commit into
mainfrom
codex/migrate-solverforge.github.io-to-docs-folder

Conversation

@blackopsrepl
Copy link
Copy Markdown
Collaborator

Motivation

  • Consolidate repository documentation into docs/ and prepare for a Bridgetown-based website migration.
  • Establish a clear reference/ layout and keep implementation runbooks in bridgetown/ to make migration deterministic.
  • Provide agent-scoped guidance for automated edits and migration tasks via AGENTS.md and runbooks.

Description

  • Update README.md to point to new docs/reference/... paths and to reference docs/README.md as the docs entrypoint.
  • Add docs/AGENTS.md with scoped instructions for agents and a validation checklist.
  • Add docs/README.md and docs/bridgetown/{agent-runbook.md,execution-plan.md} to document the Bridgetown migration workflow and exact local run steps.
  • Move existing top-level docs into docs/reference/ and add docs/reference/github-pages-migration.md describing GitHub Pages migration options.

Testing

  • No automated tests were executed because this is a documentation-only change.

Codex Task

Copy link
Copy Markdown

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

Choose a reason for hiding this comment

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

💡 Codex Review

# Typed Contract Audit and Unification Plan

P2 Badge Preserve old typed-contract-audit path or update all refs

Moving this document to docs/reference/typed-contract-audit.md without a compatibility stub leaves existing in-repo references broken; for example, crates/solverforge-core/WIREFRAME.md:612 still points to docs/typed-contract-audit.md, which now resolves to a missing file. This creates immediate doc navigation regressions for readers following the wireframe, so the move should be paired with either reference updates in the same commit or a redirect/stub at the previous path.

ℹ️ 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".

@blackopsrepl blackopsrepl deleted the codex/migrate-solverforge.github.io-to-docs-folder branch April 22, 2026 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant