docs: improve documentation visibility across GitHub touchpoints

[holytshirt]

Summary

• README: Added a GitBook documentation badge in the badge row and a callout banner directing new users to the full docs
• Issue templates: Added documentation links to both bug report and feature request templates so users check docs before filing
• PR template: Created .github/PULL_REQUEST_TEMPLATE.md with a docs checklist item

[claude]

Code Review

PR #4092 — docs: improve documentation visibility across GitHub touchpoints

Overview

This PR makes three small but valuable improvements to GitHub community health files:

1. Adds a GitBook badge and onboarding banner to README.md
2. Prepends documentation-check reminders to both issue templates
3. Introduces a new .github/PULL_REQUEST_TEMPLATE.md

These are all non-breaking documentation changes with no impact on the library code itself. The intent is clear and worthwhile — surfacing docs earlier to reduce noise from avoidable issues and PRs.

---

Findings

Bug — Broken relative link in PR template

In .github/PULL_REQUEST_TEMPLATE.md:

- [ ] I have read the [Contributing Guide](../CONTRIBUTING.md)

Relative links in PR description bodies are resolved from the repository root, not from the file's location inside .github/. The ../ prefix will navigate above the root, producing a broken link in the rendered PR description. It should be:

- [ ] I have read the [Contributing Guide](CONTRIBUTING.md)

or use an absolute URL to be unambiguous.

Minor — PR template missing a "Type of Change" section

Most effective PR templates include a quick type-of-change section so reviewers can immediately orient themselves. Consider adding something like:

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation update

This is low priority but helps reviewers and changelog authors.

Observation — Emoji usage is consistent and appropriate

The 📖 emoji is used consistently across all three template/README additions, which looks deliberate and renders well on GitHub. No issue here.

Observation — README badge placement

The new GitBook badge is appended after the CodeScene badges. This is fine; alphabetical or "importance" ordering is a style choice. No functional concern.

---

Summary

Item	Severity
Broken ../CONTRIBUTING.md relative link in PR template	Bug — should fix before merge
Missing type-of-change checklist in PR template	Low / Nice-to-have
Everything else	Looks good

The broken relative link is the only blocker. Once that's corrected to CONTRIBUTING.md, this PR is ready to merge.

---

Reviewed by Claude (claude-sonnet-4-6)

[iancooper]

@holytshirt Approved, but Claude says the link is broken

[codescene-delta-analysis]

No application code in the PR — skipped Code Health checks.

See analysis details in CodeScene

Quality Gate Profile: Clean Code Collective
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

[claude]

Code Review Update

PR #4092 — docs: improve documentation visibility across GitHub touchpoints

Following up on the earlier review: the current version of the PR addresses both issues that were flagged.

Previous Issues — Now Resolved

• Broken relative link: .github/PULL_REQUEST_TEMPLATE.md now correctly uses CONTRIBUTING.md (not ../CONTRIBUTING.md), which resolves correctly from the repo root on GitHub. ✅
• Missing Type of Change section: The PR template includes a complete ## Type of Change checklist. ✅

Current State Assessment

All three changes look good:

• README.md — GitBook badge follows the existing badge row format; the onboarding callout is well-placed above the library description.
• Issue templates — The documentation-check reminders are correctly placed before the first substantive section in both templates, so they're the first thing contributors see.
• PR template — Structure is clean: Description → Related Issues → Type of Change → Checklist → Additional Notes. The checklist aligns well with the project's documented expectations (contributing guide, XML docs, tests, code style).

This PR is ready to merge.

---

Reviewed by Claude (claude-sonnet-4-6)