17: Recipes — the shapes a host writes, and what each policy does - #31
Open
nikolaystrikhar wants to merge 1 commit into
Open
17: Recipes — the shapes a host writes, and what each policy does#31nikolaystrikhar wants to merge 1 commit into
nikolaystrikhar wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What: adds
docs/recipes.md— a settings toggle, a manifest of add-ons, the policy outcomes, the release rollout, version negotiation and per-site multisite activation — with the load gate chain, the policy branches and the rollout as Mermaid diagrams; linked from the README's doc list and fromconflict-handling.md's version-negotiation note.Read it rendered on the branch — the diagrams only draw in the blob view, not in this diff.
Usage:
Why this way:
Task-organized, in its own file. The five existing docs are organized by mechanism — every key, every filter, every gate — and none of them answers "how do I ship a toggle". The README is capped at ~120 lines and is at 84, so this could not go there.
The tagline's own case was undemonstrated. "Togglable or always-on" has been on the README since the first commit, and the only
enabledexample anywhere was a licence check. The toggle recipe also states the two things that surprise people: switching it off unloads nothing until the next request, and it stands the conflict pass down as well.Version negotiation gets a worked example, not another disclaimer. It is the decision this library keeps being asked to reopen. Ten lines of
conflict_policyfilter is a cheaper answer than the paragraph explaining why it is out of scope.Diagrams are Mermaid, and they parse. Every block was run through Mermaid's own parser, and every PHP snippet through
php -l.