Skip to content

Support Zensical documentation contracts in module site builds #536

Description

Problem

Structure-Site accepts docs/zensical.toml but stages only generated docs, the README, icon, and the configuration file into outputs/site. It does not stage docs/content/, docs/overrides/, or their assets. Build-ZensicalSite then runs from outputs/site, so a migrated configuration with docs_dir = "content" or custom_dir = "overrides" cannot build.

The Zensical migration and v8 upgrade guidance therefore cannot safely prescribe the docs/ contract to Process-PSModule consumers.

Expected outcome

Implement and test one supported documentation contract for module consumers:

  • Stage consumer-authored content, overrides, and assets so docs/zensical.toml builds with generated module documentation; or
  • Explicitly constrain the supported consumer contract to the template .github/zensical.toml layout and keep migration guidance out of the framework workflow.

Acceptance criteria

A module repository using the documented configuration can run the Process-PSModule site build successfully, preserves generated function documentation, and resolves configured content and custom-theme paths.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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