Skip to content

Update docs workflow for new docs monorepo #6463

@stevep0z

Description

@stevep0z

Context / Motivation

The docs site has migrated from Antora (docs.openzeppelin.com) to Fumadocs (OpenZeppelin/docs). The current docs.yml workflow pushes to docs-v* branches for the retired Antora site and is no longer serving the production docs.

Proposal

Replace the existing docs workflow with a trigger that calls the new docs monorepo's receiver workflow. The docs monorepo handles template injection, docgen, link validation, and PR creation.

The new workflow:

  • Triggers on release tags (v*) and supports manual dispatch
  • Calls generate-api-docs-contracts.yml in OpenZeppelin/docs via gh workflow run
  • Requires a DOCS_REPO_TOKEN secret (GitHub PAT with repo + workflow scopes)

Draft implementation: https://github.com/stevep0z/openzeppelin-contracts/tree/feat/docs-trigger-workflow

Related docs monorepo draft PR: OpenZeppelin/docs#140

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions