chore(doc): note current CRD-based version status

[dkarpele]

Closes: #1371

Summary by CodeRabbit

• Documentation
  • Added a warning note about the major transition from annotation-based to CRD-based configuration in v1.0.0
  • Clarified that v1.x versions use modern CRD-based configuration
  • Added guidance for users to reference legacy v0.x documentation for older versions

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation index updated with a warning note clarifying that annotation-based configuration was removed in v1.0.0. The note directs users to use CRD-based configuration for v1.x and references legacy v0.x documentation for older versions.

Changes

Cohort / File(s)	Change Summary
Documentation update docs/index.md	Adds warning note clarifying transition from annotation-based to CRD-based configuration in v1.0.0, with guidance to appropriate version documentation

Pre-merge checks

✅ 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 'chore(doc): note current CRD-based version status' directly relates to the main change: adding documentation about the version status of CRD-based configuration.
Linked Issues check	✅ Passed	The PR adds a warning note about the transition from annotation-based to CRD-based configuration in v1.0.0, directly addressing issue #1371's requirement to make documentation explicitly state the removal.
Out of Scope Changes check	✅ Passed	The changes are limited to documentation text in docs/index.md, directly addressing the linked issue #1371 with no out-of-scope modifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.80%. Comparing base (73263e7) to head (ec4f458).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1373   +/-   ##
=======================================
  Coverage   70.80%   70.80%           
=======================================
  Files          49       49           
  Lines        4528     4528           
=======================================
  Hits         3206     3206           
  Misses       1125     1125           
  Partials      197      197           

☔ 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/index.md (1)

7-12: Consider adding explicit link or pointer for accessing v0.x documentation.

The note directs users to "consult the documentation for the respective version" but doesn't specify how to access v0.x docs (e.g., specific branch, git tag, separate documentation site). Adding an explicit pointer (e.g., a link to the v0.17.0 tag, a separate versioned docs site, or a git command) would improve discoverability for users migrating from older versions.

Suggested improvement:

Consider enhancing the note with a direct link or clearer instructions. For example:

~    annotation-based configuration for versions v0.x (e.g. `0.17.0`), please
-    consult the documentation for the respective version.
+    annotation-based configuration for versions v0.x (e.g. `0.17.0`), please
+    refer to the
+    [v0.17.0 release documentation](https://github.com/argoproj-labs/argocd-image-updater/tree/v0.17.0/docs)
+    or check out the appropriate git tag.

Alternatively, if versioned docs are hosted separately (e.g., ReadTheDocs), link to the legacy version selector there instead.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 73263e7 and ec4f458.

📒 Files selected for processing (1)

• docs/index.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: Ensure registry-scanner Go modules synchronicity and run tests
• GitHub Check: Ensure code is correctly linted
• GitHub Check: Ensure unit tests are passing
• GitHub Check: Analyze (go)
• GitHub Check: build_image

🔇 Additional comments (1)

docs/index.md (1)

7-12: Excellent: Clear, prominent warning about annotation-based deprecation.

The warning note directly addresses issue #1371 by explicitly stating that annotation-based configuration was removed in v1.0.0 and clarifying that v1.x uses CRD-based configuration. Placement at the top of the index ensures high visibility for users encountering the documentation.