Skip to content

docs: add documentation authoring guideline - #598

Closed
gbrlcustodio wants to merge 2 commits into
docs/architecture-principlesfrom
docs/authoring
Closed

docs: add documentation authoring guideline#598
gbrlcustodio wants to merge 2 commits into
docs/architecture-principlesfrom
docs/authoring

Conversation

@gbrlcustodio

@gbrlcustodio gbrlcustodio commented Aug 11, 2026

Copy link
Copy Markdown
Member

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 the docs/ tree is organized and where a new doc goes. It joins its siblings architecture.md and conventions.md, and is linked from docs/README.md and AGENTS.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):

  • Where a doc goes: audience first (contributor, consumer-by-surface, durable cross-cutting at root), then Diataxis kind, one kind per file where practical.
  • Generate fast-changing reference from code (docstrings, Field(description=...), the registry, Typer help); hand-author only where no code source exists; never mix a generated table with durable prose.
  • Keep it small: keep recognizable names, do not invent buckets for a few files, and send concrete migration steps to issues rather than a checklist in the doc.

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.md and the config.md table; relocate ipaas.md under docs/mcp/; split the four-quadrant cli/auth.md and portal's contributor testing content; separate the contributor tails in MIGRATION.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.py assertions, and the CLI golden snapshot are untouched. Links resolve; no em or en dashes or curly quotes.

… 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
gbrlcustodio force-pushed the docs/architecture-principles branch from e2908ab to 2f9e758 Compare August 12, 2026 17:57
@gbrlcustodio
gbrlcustodio force-pushed the docs/architecture-principles branch from 2f9e758 to e5b7ead Compare August 12, 2026 18:46
@gbrlcustodio

Copy link
Copy Markdown
Member Author

Closing. docs/contributing/authoring.md now ships in #602, unchanged in content.

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.

The branch stays until #597 and #602 merge.

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