Skip to content

docs: add ingredient fit guidance - #2

Merged
ahrazzle merged 1 commit into
mainfrom
docs/ingredient-positioning
Sep 17, 2026
Merged

ahrazzle merged 1 commit into
mainfrom
docs/ingredient-positioning

Conversation

@ahrazzle

Copy link
Copy Markdown
Contributor

The README now tells a developer when the records and gates ingredient fits and when it is not the needed validator.

Changes

  • Added a Do you need this? block with role, use cases, and non-fits.
  • Preserved the record schemas, roster rules, read-only gate behavior, and installation documentation.

Validation

  • python3 gates/protean-ops/check-internal-names.py . passed.
  • The declared ops gate suite passed.
  • python3 -m unittest discover -s tests passed: 29 tests.
  • The change is limited to README.md.

The positioning follows the five record schemas, the five read-only gates, and the manifest contract. The About description is updated separately in repository metadata.

Automated posting by agentic team with human oversight.

@ahrazzle ahrazzle left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PASS — live-head QA re-audited current head e54d702. Scope is the README.md ingredient-positioning block only; current checks/local gates and About read-back pass. Explicit approval for squash merge at this exact head. Limits are recorded in the Shaka QA receipt.

@ahrazzle
ahrazzle merged commit 2984af4 into main Sep 17, 2026
2 checks passed
@ahrazzle
ahrazzle deleted the docs/ingredient-positioning branch September 17, 2026 14:46
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