Skip to content

[TASK][MVP] Build the Shared StateForge Documentation Theme - #2

Merged
Noam-Alum merged 6 commits into
mvp/implementationfrom
mvp/shared-documentation-theme
Oct 27, 2026
Merged

Noam-Alum merged 6 commits into
mvp/implementationfrom
mvp/shared-documentation-theme

Conversation

@Noam-Alum

Copy link
Copy Markdown
Member

Required result

Outcome and ownership

Create the shared StateForge documentation presentation package owned by stateforge-docs. Publish one installable Python distribution, stateforge-docs-theme, exposing the MkDocs theme name stateforge and extending Material for MkDocs without forking it.

Required behavior

  • Bundle the official StateForge mark, favicon, brand tokens, typography, spacing, responsive layout, light/dark presentation, navigation treatment, repository link treatment, code styling, and accessible focus/contrast behavior.
  • Support a common StateForge identity plus explicit component accents for Agent, Provider Python, Protocol, Control Plane, SF-AOP, and future repositories without copying CSS or assets into consumers.
  • Keep content, navigation, repository metadata, and repository-specific plugins owned by each consuming repository.
  • Provide stable theme configuration for the version selector and historical-version warning used by later publishing work.
  • Package templates and static assets reproducibly in wheel and sdist. Do not load branding from a moving branch or remote runtime resource.
  • Keep Material-specific overrides minimal and documented so a later centrally managed Zensical migration does not require rewriting repository content.

Acceptance evidence

A clean environment installs the exact wheel and sdist, selects theme.name: stateforge, and builds representative documentation with bundled assets only. Automated tests cover package contents, theme discovery, responsive light/dark rendering, keyboard focus, contrast, logo/favicon resolution, component accents, and absence of consumer-local branding copies.

Non-goals

No repository-specific documentation content, no documentation hosting, no release/version deployment, no StateForge runtime code, and no Zensical migration in this milestone.

Implementation step

D0

Closes #1

@Noam-Alum Noam-Alum added dpt:project:stateforge StateForge DPT project tracking dpt:release:mvp StateForge DPT release tracking dpt:step:D0 StateForge DPT implementation step labels Oct 27, 2026
@Noam-Alum Noam-Alum self-assigned this Oct 27, 2026
@Noam-Alum
Noam-Alum merged commit bcf1596 into mvp/implementation Oct 27, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dpt:project:stateforge StateForge DPT project tracking dpt:release:mvp StateForge DPT release tracking dpt:step:D0 StateForge DPT implementation step

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant