// SPDX-License-Identifier: CC-BY-SA-4.0
// SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath)
= Users track — consuming & adopting the standards
:toc:
:toc-placement: preamble
:status: Scaffold v0.1.0 (2026-06-21)

For repo owners and teams who **adopt** the Hyperpolymath standards or
**consume** their outputs (reusable workflows, A2ML metadata, policies,
readiness grades). You are not editing the standards themselves — you are
applying them.

NOTE: Scaffold. The link spine is complete; the connective prose is `TODO`.

== Learning path

=== 1. Orient — what *are* these standards?

* `README.adoc` (§Overview) — the human front door.
* `EXPLAINME.adoc` — the architecture-decisions narrative.
* TODO: one-paragraph "standards in plain language" for newcomers.

=== 2. The machine-readable artefacts (6a2)

Every Hyperpolymath repo carries six A2ML files (`STATE`, `META`, `ECOSYSTEM`,
`AGENTIC`, `NEUROSYM`, `PLAYBOOK`) plus `ANCHOR`.

* Canonical layout + meaning: `0-AI-MANIFEST.a2ml` (§CANONICAL LOCATIONS).
* TODO: "what each artefact is for, as a consumer reading someone else's repo".

=== 3. Adopt the standards in your repo

* `A2ML-REPO-TEMPLATE.adoc` — the template to stand a repo up.
* `setup.sh` — bootstrap.
* `TEMPLATE-APPLICABILITY-POLICY.adoc` — which parts apply to which repo shapes.
* TODO: a 10-minute "adopt on an existing repo" worked example.

=== 4. Consume the reusable workflows

Standards hosts reusable CI workflows you pin by SHA
(`governance-reusable.yml`, `hypatia-scan-reusable.yml`,
`scorecard-reusable.yml`, …).

* How pinning + *pin freshness* works — and why your CI no longer reds on
  every standards commit: link:../../decisions/ADR-003-workflow-pin-staleness-window.adoc[ADR-003].
* Bumping a pin deliberately: `scripts/propagate-workflow-pins.sh` (audit-first).
* TODO: copy-paste consumer workflow snippets per reusable.

=== 5. Readiness grades — reading the labels

ARG / FRG / CRG / TRG tell you how mature a repo/component is.

* `adoption-readiness-grades/`, `foundations-readiness-grades/`,
  `component-readiness-grades/`, `toolchain-readiness-grades/`.
* TODO: "how to read a grade badge and what it promises you".

=== 6. Get help

* `QUICKSTART-USER.adoc`, `llm-warmup-user.md`.
* Issues: https://github.com/hyperpolymath/standards/issues
