docs: revert hardcoded getting-started link to README.md#2767
Conversation
PR Summary by QodoDocs: revert org-mode Getting Started link to canonical README.md
AI Description
High-Level Assessment
Files changed (1)
|
Site previewPreview: https://69ae3715-site.fullsend-ai.workers.dev Commit: |
|
🤖 Finished Review · ✅ Success · Started 8:14 PM UTC · Completed 8:23 PM UTC |
Code Review by Qodo
1. Guide not in admin/user
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Looks good to me Follow-up: Within the Previous runLooks good to me Labels: PR modifies documentation under docs/guides/ |
The link in the org-mode deprecation notice was hardcoded to `../getting-started/` as a workaround for VitePress not resolving README.md links. Now that #2765 adds a markdown-it rewrite rule to handle this automatically, revert to the canonical `README.md` reference. Assisted-by: Claude Signed-off-by: Wayne Sun <gsun@redhat.com>
d5b8ecc to
ab013ad
Compare
|
🤖 Finished Review · ✅ Success · Started 11:07 PM UTC · Completed 11:16 PM UTC |
| # Per-Org Mode | ||
|
|
||
| > **Planned deprecation.** Per-org installation mode will be deprecated in favor of per-repo installation ([ADR 0044](../../ADRs/0044-deprecate-per-org-installation-mode.md)). New installations should use the [per-repo Getting Started guides](../getting-started/). Existing per-org installations continue to work and are fully supported during the transition. | ||
| > **Planned deprecation.** Per-org installation mode will be deprecated in favor of per-repo installation ([ADR 0044](../../ADRs/0044-deprecate-per-org-installation-mode.md)). New installations should use the [per-repo Getting Started guides](README.md). Existing per-org installations continue to work and are fully supported during the transition. |
There was a problem hiding this comment.
[low] documentation-link-pattern-inconsistency
Within the getting-started directory, operations.md (lines 7, 154) uses ../getting-started/ to link back to the same directory index, while org-mode.md (after this PR) and configuring-github.md (line 11) use README.md. Both resolve to the same target, but the style is inconsistent among sibling files.
Suggested fix: Update operations.md lines 7 and 154 to use README.md instead of ../getting-started/ since the file is already inside the getting-started directory.
|
🤖 Finished Retro · ✅ Success · Started 3:44 PM UTC · Completed 3:50 PM UTC |
Retro: PR #2767 — docs: revert hardcoded getting-started link to README.mdWhat happened: PR #2767 was a trivial 1-line documentation change by Wayne Sun, reverting a hardcoded Timeline:
Assessment: The workflow performed correctly. The double review was caused by a force push triggering the Improvement areas considered but already tracked:
No new proposals are warranted — all identified improvement opportunities are already captured in the existing issue backlog. |
Summary
../getting-started/link in the org-mode deprecation notice back to the canonicalREADME.mdreferenceREADME.mdlinksDepends on
README.mdlinks to./, making this hardcode unnecessaryTest plan