Skip to content

docs: remove version annotations - #1694

Merged
chhoumann merged 1 commit into
masterfrom
docs/remove-version-annotations
Aug 23, 2026
Merged

docs: remove version annotations#1694
chhoumann merged 1 commit into
masterfrom
docs/remove-version-annotations

Conversation

@chhoumann

@chhoumann chhoumann commented Aug 23, 2026

Copy link
Copy Markdown
Owner

Removes all "Introduced in QuickAdd X.Y.Z" / "Changed in QuickAdd X.Y.Z" version annotations from the docs, along with the AGENTS.md paragraphs that prescribed the convention.

The docs are single-version and track master, so per-section version markers add noise without helping readers. Historical behavior notes ("Before 2.20.0 ...") only made sense under that convention and go with it. The three FormatSyntax callouts that were the sole documentation of the |format: option are unwrapped into plain prose rather than deleted, so no current-behavior content is lost.

The versioned-URL 301s in docs/public/_redirects are intentionally untouched - they serve live inbound links.

Summary by CodeRabbit

  • Documentation
    • Updated documentation guidelines to use stable URLs and require permanent redirects when links change.
    • Removed outdated version-introduction notes across AI Assistant, CLI, URI, capture, template, format syntax, and API documentation.
    • Streamlined documentation by removing historical compatibility annotations while preserving current usage guidance.

@coderabbitai

coderabbitai Bot commented Aug 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 87ad6b92-4503-46f9-94fb-8fbdefdef757

📥 Commits

Reviewing files that changed from the base of the PR and between ebd65ac and 729ca0c.

📒 Files selected for processing (8)
  • AGENTS.md
  • docs/src/content/docs/docs/AIAssistant.md
  • docs/src/content/docs/docs/Advanced/CLI.md
  • docs/src/content/docs/docs/Advanced/ObsidianUri.md
  • docs/src/content/docs/docs/Choices/CaptureChoice.md
  • docs/src/content/docs/docs/Choices/TemplateChoice.md
  • docs/src/content/docs/docs/FormatSyntax.md
  • docs/src/content/docs/docs/QuickAddAPI.md
💤 Files with no reviewable changes (6)
  • docs/src/content/docs/docs/Advanced/ObsidianUri.md
  • docs/src/content/docs/docs/AIAssistant.md
  • docs/src/content/docs/docs/Choices/CaptureChoice.md
  • docs/src/content/docs/docs/Choices/TemplateChoice.md
  • docs/src/content/docs/docs/FormatSyntax.md
  • docs/src/content/docs/docs/QuickAddAPI.md

Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.


📝 Walkthrough

Walkthrough

Changes

The documentation policy now uses stable slugs and redirects for renamed pages. Documentation pages no longer include historical version-introduction notes or legacy behavior annotations.

Documentation cleanup

Layer / File(s) Summary
Documentation policy guidance
AGENTS.md
The policy retains stable slug and redirect requirements and removes versioned documentation guidance.
Page annotation cleanup
docs/src/content/docs/docs/Advanced/*, docs/src/content/docs/docs/Choices/*, docs/src/content/docs/docs/QuickAddAPI.md
Historical feature-introduction and behavior notes were removed. Current documentation content remains.
Format syntax annotation cleanup
docs/src/content/docs/docs/FormatSyntax.md
Version-note wrappers and introduction annotations were removed while format guidance remains.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 729ca

This change removes outdated version annotations from the documentation while retaining the relevant current-behavior guidance, so no actionable merge-blocking risk remains beyond normal checks and review.

Poem

I’m a rabbit with tidy docs,
Snipping old release clocks.
Stable slugs hop in line,
Redirects mark each sign.
Current guidance shines bright—
No version notes in sight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main documentation change: removing version annotations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/remove-version-annotations

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying quickadd with  Cloudflare Pages  Cloudflare Pages

Latest commit: 729ca0c
Status: ✅  Deploy successful!
Preview URL: https://9fd91ac5.quickadd.pages.dev
Branch Preview URL: https://docs-remove-version-annotati.quickadd.pages.dev

View logs

@chhoumann
chhoumann merged commit ddc028d into master Aug 23, 2026
13 checks passed
@chhoumann
chhoumann deleted the docs/remove-version-annotations branch August 23, 2026 20:40
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