8000 docs: author the last context stubs (deprecations, decisions, api-standard) by irfan-dahir · Pull Request #608 · jikan-me/jikan · GitHub
[go: up one dir, main page]

Skip to content

docs: author the last context stubs (deprecations, decisions, api-standard) - #608

Merged
irfan-dahir merged 1 commit into
docs/changelog-contributingfrom
docs/remaining-context-stubs
Oct 11, 2026
Merged

irfan-dahir merged 1 commit into
docs/changelog-contributingfrom
docs/remaining-context-stubs

Conversation

@irfan-dahir
Copy link
Copy Markdown
Collaborator

Stacked on #607. Completes the context layer: doc debt goes 4-of-7 → 7-of-7 — every mapped role now has an authored document.

DEPRECATIONS.md — authored (stub removed)

Real ledger, rows measured from the @deprecated tags in src/Model:

  • 9 currently-deprecated accessors, each with a verified replacement: Anime::getTitle* (4) and Manga::getTitle* (4) → getTitles(): array; Producer::getName() → getTitles(): array.
  • The v4→v5 diff removed nothing, so Removed is empty with the retention rule stated.
  • §5 is a running grep -rn "@deprecated" src/Model reconciliation, logged as a future toolchainGates candidate.

DECISIONS.md — finished (stub marker removed)

The template's open DECIDE questions answered in-document: organisation (topical, Date carries chronology), corrections (inline **Correction (date):** paragraph is the standard), split trigger (25 entries per section), and significance threshold ("would a reader in a year assume this was a mistake?"). The two existing entries (constants, exemptions) retained verbatim.

API-STANDARD.md — authored (stub removed)

Everything measured from the ^5 codebase, so review rejects drift from reality, not toward aspiration:

  • naming tables (Request/Parser/Model/client/Constants conventions, PSR-1/12);
  • the public-entry-point contract (Request value object in, Model out, ParserException/BadResponseException envelope, typed nullability, Constants::DISPLAY_* rule);
  • the observed Results/Pagination shape;
  • the versioning/deprecation flow shared with CHANGELOG/DEPRECATIONS;
  • §6: the things review rejects (raw literals for display strings, calls bypassing httpClientWrapper, raw Crawler leakage, live-network tests);
  • §7: two explicitly-open items for your sign-off (deprecation removal versions; anything in this doc a reviewer wants to change becomes a deliberate doc+code change) — no silent guessing.

Result

resolve --all: all 7 roles AUTHORED (no stubs) · 5 declined · 0 unmapped-and-undecided
quality-debt: Documentation: 7 of 7 mapped role(s) actually written.

Committed through the merged pre-commit hook (suite gates + grumphp, clean).

…andard

Doc debt goes 4-of-7 -> 7-of-7: every mapped role now has an authored document
(resolve exits 0; explicitly declined roles are the only non-written ones).

- DEPRECATIONS.md: real ledger, rows measured from @deprecated tags in src/Model.
  Nine currently-deprecated accessors (Anime::getTitle*, Manga::getTitle*,
  Producer::getName) each map to the getTitles() replacement; the v4->v5 diff
  removed nothing, so the Removed table is empty with the retention rule stated;
  section 5 is a running grep reconciliation, logged as a future toolchain-gate
  candidate.

- DECISIONS.md: finished (stub marker removed). The template's open DECIDEs are
  answered (organisation=topical, corrections=inline paragraph, split at 25
  entries/section, significance = 'would a reader assume a mistake?'), with the
  two existing entries retained and the decision-format references kept.

- API-STANDARD.md: authored from MEASURED conventions of the ^5 codebase (naming
  tables, the Request/Parser/Model/client contract, the exception envelope,
  Results/Pagination shape, Constants::DISPLAY_* rule), so review rejects code
  drifting from reality rather than toward aspiration. Section 7 names the two
  genuinely-open items for maintainer sign-off instead of guessing.

Committed through the merged pre-commit hook (suite gates + grumphp).
@irfan-dahir
irfan-dahir merged commit 18ec91b into docs/changelog-contributing Oct 11, 2026
3 checks passed
CrafterSama pushed a commit to CrafterSama/jikan that referenced this pull request Oct 27, 2026
6-PR review fixes: docs.manifest.json._readme still described api-standard,
changelog, contributing, decisions and deprecations as unwritten stubs
(resolve exit 5); they have all been authored (jikan-me#607/jikan-me#608). Now states all
seven mapped roles are authored and five are declined. survey.json (derived)
re-run so its source stamp and census reflect the current tree.

Whole-stack review status at HEAD: repo-health 8 clean / 0 findings / 11
honest refusals; quality-debt all-A; composer test 394/394.
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

0