Skip to content

docs: fix broken anchors and stale Doctrine annotation references#799

Merged
oojacoboo merged 1 commit intothecodingmachine:masterfrom
oojacoboo:docs/clean-stale-annotation-references
Apr 22, 2026
Merged

docs: fix broken anchors and stale Doctrine annotation references#799
oojacoboo merged 1 commit intothecodingmachine:masterfrom
oojacoboo:docs/clean-stale-annotation-references

Conversation

@oojacoboo
Copy link
Copy Markdown
Collaborator

@oojacoboo oojacoboo commented Apr 21, 2026

Summary

Doctrine annotation support was dropped in #677, and the relevant section headings were subsequently renamed from "annotation(s)" to "attribute(s)". A handful of in-repo links and wording were missed in that rename — this PR cleans them up.

Broken anchors (navigation currently breaks)

  • annotations-reference.md #[Type] section: #input-annotation / #factory-annotation#input / #factory (sections are now ## #[Input] and ## #[Factory]).
  • authentication-authorization.mdx + fine-grained-security.mdx: #logged-and-right-annotations#logged-and-right-attributes (section is ## #[Logged]and#[Right] attributes).

Stale / contradictory wording

  • queries.mdx "About attributes": the Doctrine example was shown as #[Query], which is the new-style syntax. Corrected to @Query and rephrased so the old-vs-new distinction actually reads.
  • annotations-reference.md intro: reworded to reflect that only the PHP 8 attribute format exists now. Kept the link to the migration guide since existing users still benefit from it.
  • annotations-reference.md #[Assertion]: Type column said annotation while the description said attributes — aligned to attribute.

Intentionally left alone

  • CHANGELOG.md — historical record.
  • migrating.md — historical migration guide, references @SourceField etc. on purpose.
  • doctrine-annotations-attributes.mdx — migration guide, still useful for users on the old syntax.
  • annotations parameter on #[SourceField] / #[MagicField] — that's the actual PHP parameter name in the source, not stale terminology.
  • PHP namespace references like TheCodingMachine\GraphQLite\Annotations\* — real symbol names.

Test plan

  • Diff is link/wording changes only; no structural or behavioral edits.
  • Render the Docusaurus site locally and click through the four affected pages to confirm the anchor links land on the right sections.

Doctrine annotation support was dropped in thecodingmachine#677, and the relevant
section headings were subsequently renamed from "annotation"/"annotations"
to "attribute"/"attributes". A handful of in-repo links and wording
were missed in that rename:

- annotations-reference.md #[Type] section: `#input-annotation` /
  `#factory-annotation` → `#input` / `#factory` (sections are now
  `## #[Input]` and `## #[Factory]`).
- authentication-authorization.mdx + fine-grained-security.mdx:
  `#logged-and-right-annotations` → `#logged-and-right-attributes`
  (section is `## #[Logged]` and `#[Right]` attributes`).
- queries.mdx "About attributes": the Doctrine example was shown as
  `#[Query]`, which is the new-style syntax. Corrected to `@Query` and
  rephrased the line so the old-vs-new distinction actually reads.
- annotations-reference.md intro: reworded to reflect that only the
  PHP 8 attribute format exists now; kept the link to the migration
  guide since existing users still need it.
- annotations-reference.md #[Assertion]: Type column said `annotation`
  while the description said `attributes` — aligned to `attribute`.

Intentionally left alone: CHANGELOG.md (historical), migrating.md
(historical migration guide), doctrine-annotations-attributes.mdx
(migration guide, still useful), and the `annotations` parameter on
#[SourceField] / #[MagicField] (actual PHP parameter name in the
source). PHP namespace references (TheCodingMachine\GraphQLite\
Annotations\*) are real symbol names and not stale.
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.84%. Comparing base (53f9d49) to head (6340e58).
⚠️ Report is 150 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master     #799      +/-   ##
============================================
- Coverage     95.72%   94.84%   -0.89%     
- Complexity     1773     1869      +96     
============================================
  Files           154      175      +21     
  Lines          4586     5079     +493     
============================================
+ Hits           4390     4817     +427     
- Misses          196      262      +66     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@oojacoboo oojacoboo merged commit 2d643f8 into thecodingmachine:master Apr 22, 2026
13 checks passed
@oojacoboo oojacoboo deleted the docs/clean-stale-annotation-references branch April 22, 2026 00:34
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.

2 participants