Skip to content

feat(docs): add the rup-flow documentation site - #1

Merged
hector-ae21 merged 2 commits into
v0.xfrom
feat/initial-site
Oct 18, 2026
Merged

hector-ae21 merged 2 commits into
v0.xfrom
feat/initial-site

Conversation

@hector-ae21

Copy link
Copy Markdown
Owner

What and why

The first version of the rup-flow documentation site. It reuses the structure, tooling and styling of the octoform documentation (MkDocs Material, Mike versioning, immutable publication tags, strict validation) and takes its colors from the rup-flow logo.

  • The free edition is documented completely: install, first run, guides, CLI, configuration, folder structure, front matter, provenance, the three free diagrams, architecture.
  • rup-flow Pro is described at feature level only. Nothing here can be used to recreate a Pro capability: no Pro commands, flags, configuration keys, templates or procedures.
  • The comparison page is generated from the editions catalogue of the free repository.
  • The documented free version is rupFlow.version in package.json (0.4.0); it drives the release line.

Verification

  • markdownlint, cspell, release tests, PlantUML check, strict MkDocs build, html-validate, privacy and secret scans pass locally.
  • Link validation reports only the links to this repository, which did not exist yet.
  • The accessibility check runs in CI.

octoform-specific validators (examples, version pins, site UX scenarios) were not carried over.

Versioned MkDocs Material site that follows the structure, tooling and
styling of the octoform documentation, in the colors of the rup-flow logo.
It documents the free edition completely and describes rup-flow Pro at
feature level only, so nothing there can recreate a Pro capability.

The documented free version is declared in package.json (rupFlow.version)
and drives the release line, the immutable publication tags and the
version selector.
@hector-ae21
hector-ae21 merged commit bdab743 into v0.x Oct 18, 2026
4 checks passed
@hector-ae21
hector-ae21 deleted the feat/initial-site branch October 18, 2026 14:53
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