Skip to content

Launch versioned documentation with a five-minute adoption path #236

Description

@codeforester

Parent: #214

Train position: 22 of 26
Phase: P3 — Ecosystem trust and broad adoption

Problem

The module references are deep, but the project lacks an adoption funnel that takes a new user from installation to a tested, bundled application and then explains the framework's architecture, contracts, compatibility, security, and upgrade model.

Acceptance criteria

  • Publish a versioned documentation site and README funnel whose copy-and-paste quickstart pins the exact verified v2 RC during validation and v2 GA after release, then initializes, tests, checks, and bundles a working application in under five minutes.
  • Document architecture, execution and initialization, modules and imports, command schemas, configuration and environment, lifecycle and signals, outputs and statuses, observability, testing, vendoring, bundling, and releases.
  • Make v2 the default documentation version, archive pre-v2 material as unsupported, and publish an explicit v1.4.0-to-v2 migration guide that does not suggest v1.5.0 or require legacy shims.
  • Explain macOS Bash 3.2 remediation and the exact supported Bash, OS, libc, userland, and external-command matrix prominently.
  • Publish factual comparison and integration guidance for Bashly, Argc, Argbash, Bats, ShellCheck, shfmt, Modernish, boilerplates, and package managers without unsupported superiority claims.
  • Run every executable example and internal link in CI, pin all installation inputs, and prevent examples from depending on unreleased main.
  • Use standalone community-facing terminology and show production patterns rather than only API cookbooks.

Dependencies

Metadata

Metadata

Assignees

Labels

documentationDocumentation improvements

Type

No type

Projects

Status
Backlog

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions