docs: add documentation authoring guideline - #598
Closed
gbrlcustodio wants to merge 2 commits into
Closed
Conversation
gbrlcustodio
force-pushed
the
docs/authoring
branch
from
August 11, 2026 22:00
a123fe5 to
2b0b1a7
Compare
This was referenced Aug 11, 2026
gbrlcustodio
force-pushed
the
docs/architecture-principles
branch
from
August 11, 2026 23:32
954633e to
32beb39
Compare
gbrlcustodio
force-pushed
the
docs/authoring
branch
from
August 11, 2026 23:32
2b0b1a7 to
58b44e5
Compare
gbrlcustodio
force-pushed
the
docs/architecture-principles
branch
from
August 11, 2026 23:54
32beb39 to
e2908ab
Compare
gbrlcustodio
force-pushed
the
docs/authoring
branch
from
August 11, 2026 23:54
58b44e5 to
b2cd65b
Compare
… conventions Fold the boundary cluster (validate at the edge, parse don't validate, self-guaranteeing types), type ownership, and the response-typing rule into docs/contributing/conventions.md. Re-scope architecture into docs/contributing/architecture.md around the layer model, composition root, ports, and the three surfaces. Thin the root AGENTS.md coding sections to a router that points to the two design docs. Remove docs/architecture.md and docs/response-typing.md, whose content moved. Repoint docs/README.md, packages/mcp/pyproject.toml, and packages/mcp/AGENTS.md at the new paths. Signed-off-by: Gabriel <gabriel.custodio@pipefy.com>
Signed-off-by: Gabriel <gabriel.custodio@pipefy.com>
gbrlcustodio
force-pushed
the
docs/architecture-principles
branch
from
August 12, 2026 17:57
e2908ab to
2f9e758
Compare
gbrlcustodio
force-pushed
the
docs/authoring
branch
from
August 12, 2026 17:57
b2cd65b to
ec3c27f
Compare
gbrlcustodio
force-pushed
the
docs/architecture-principles
branch
from
August 12, 2026 18:46
2f9e758 to
e5b7ead
Compare
Member
Author
|
Closing. The reason is that this PR and #602 churned against each other. This PR added the file at 23 lines, and #602 added a "Decision records" section to it one commit later. A reviewer here would have read a file that the next PR in the stack immediately edited, and 25 lines across 3 files is smaller than the overhead of a separate review. In #602 the file arrives complete, with its decision-records section already in place, alongside the records that the section describes. That pairing is the natural unit: the guideline says where a record lives, and the same PR puts the records there. |
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.
Stacked on #597. Base is
docs/architecture-principles, so this diff shows only the Phase 2 change. Review and merge #597 first.What
Add
docs/contributing/authoring.md, a short contributor guideline for how thedocs/tree is organized and where a new doc goes. It joins its siblingsarchitecture.mdandconventions.md, and is linked fromdocs/README.mdandAGENTS.md.Why
Phase 1 derived a set of rules for the docs tree but never wrote them down. This records them, cut to the irreducible set (mantra: less brings clarity, more brings confusion):
Field(description=...), the registry, Typer help); hand-author only where no code source exists; never mix a generated table with durable prose.The target, not the current state
The guideline describes the target the tree converges to. The current tree is mid-migration. It states the rules, not a status list, because status rots. The known divergences (generate
parity.mdand theconfig.mdtable; relocateipaas.mdunderdocs/mcp/; split the four-quadrantcli/auth.mdand portal's contributor testing content; separate the contributor tails inMIGRATION.md/parity.md) are staged as separate, reviewed steps tracked in issues. Each is load-bearing in code or tests, so none happen here.Testing
Docs-only: one new file (23 lines) plus two index rows. No code, test, or fixture path changed, so the parity test, the auth
_docs.pyassertions, and the CLI golden snapshot are untouched. Links resolve; no em or en dashes or curly quotes.