Skip to content

docs: revert hardcoded getting-started link to README.md#2767

Merged
waynesun09 merged 1 commit into
mainfrom
fix-org-mode-readme-link
Jul 1, 2026
Merged

docs: revert hardcoded getting-started link to README.md#2767
waynesun09 merged 1 commit into
mainfrom
fix-org-mode-readme-link

Conversation

@waynesun09

Copy link
Copy Markdown
Member

Summary

Depends on

Test plan

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Docs: revert org-mode Getting Started link to canonical README.md

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Restore the org-mode deprecation notice link to reference README.md
• Remove the previously hardcoded ../getting-started/ workaround now handled elsewhere
High-Level Assessment

Reverting to the canonical README.md link is the right long-term approach, assuming the referenced markdown-it/VitePress rewrite rule is in place. Alternatives (keeping a hardcoded path or duplicating content) would be more brittle and harder to maintain.

Files changed (1) +1 / -1

Documentation (1) +1 / -1
org-mode.mdRevert org-mode guide link to README.md +1/-1

Revert org-mode guide link to README.md

• Updates the planned deprecation notice to link to the canonical per-repo Getting Started entry (README.md) instead of a hardcoded ../getting-started/ path. This removes a docs-site rendering workaround in favor of a stable internal reference.

docs/guides/getting-started/org-mode.md

@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown

Site preview

Preview: https://69ae3715-site.fullsend-ai.workers.dev

Commit: ab013adc1e8a063fd057cafec7cf5fe554224668

@fullsend-ai-review

fullsend-ai-review Bot commented Jun 29, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 8:14 PM UTC · Completed 8:23 PM UTC
Commit: d5b8ecc · View workflow run →

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📜 Skill insights (2)

Context used
✅ Compliance rules (platform): 51 rules

Grey Divider


Informational

1. Guide not in admin/user 📜 Skill insight ⌂ Architecture
Description
The modified guide file is under docs/guides/getting-started/, but guides must live under either
docs/guides/admin/ or docs/guides/user/. This breaks the required guide directory structure and
audience separation expectations for docs guides.
Code

docs/guides/getting-started/org-mode.md[7]

+> **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.
Relevance

⭐ Low

Repo intentionally added docs/guides/getting-started/ guides (org-mode.md) outside admin/user in PRs
2124/2698.

PR-#2124
PR-#2698

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The checklist requires guide files under docs/guides/ to be placed in either admin/ or user/
subdirectories. The changed file is located at docs/guides/getting-started/org-mode.md and
contains guide content, but it is not under either required subdirectory.

docs/guides/getting-started/org-mode.md[7-7]
Skill: writing-user-docs

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`docs/guides/getting-started/org-mode.md` is a documentation guide outside the allowed `docs/guides/admin/` or `docs/guides/user/` subdirectories.

## Issue Context
Compliance requires each guide under `docs/guides/` to be placed in either the admin or user guide hierarchy.

## Fix Focus Areas
- docs/guides/getting-started/org-mode.md[1-15]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


2. Planned callout missing issue 📜 Skill insight ≡ Correctness
Description
The guide uses a planned-change callout (> **Planned deprecation.** ...) but does not follow the
required > **Planned:** format and does not include an issue link. This makes planned behavior
easy to misread as current and breaks the documentation callout convention.
Code

docs/guides/getting-started/org-mode.md[7]

+> **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.
Relevance

⭐ Low

Repo already uses “Planned deprecation.” callout without issue link in org-mode.md (added/kept in
PRs 2124/2698).

PR-#2124
PR-#2698

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The checklist requires any mention of planned (not-yet-implemented) behavior to use the `>
**Planned:** callout format and include a link to the relevant issue. The modified line uses >
**Planned deprecation.**` and includes no issue link.

docs/guides/getting-started/org-mode.md[7-7]
Skill: writing-user-docs

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The planned-change callout does not use the required `> **Planned:**` format and does not include a link to a tracking issue.

## Issue Context
Docs guides must present planned (not-yet-implemented) or future changes using the standardized callout and include an issue link for tracking.

## Fix Focus Areas
- docs/guides/getting-started/org-mode.md[7-7]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

@codecov

codecov Bot commented Jun 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@fullsend-ai-review

fullsend-ai-review Bot commented Jun 29, 2026

Copy link
Copy Markdown

Looks good to me


Follow-up: Within the docs/guides/getting-started/ directory, operations.md (lines 7, 154) still uses ../getting-started/ to self-reference the directory index, while org-mode.md (after this PR) and configuring-github.md use README.md. Consider updating operations.md to use README.md for consistency.

Previous run

Looks good to me


Labels: PR modifies documentation under docs/guides/

@fullsend-ai-review fullsend-ai-review Bot added ready-for-merge All reviewers approved — ready to merge component/docs User-facing documentation labels Jun 29, 2026
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>
@fullsend-ai-review

fullsend-ai-review Bot commented Jun 29, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 11:07 PM UTC · Completed 11:16 PM UTC
Commit: ab013ad · View workflow run →

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@fullsend-ai-review fullsend-ai-review Bot added ready-for-merge All reviewers approved — ready to merge and removed ready-for-merge All reviewers approved — ready to merge labels Jun 29, 2026
@waynesun09 waynesun09 added this pull request to the merge queue Jul 1, 2026
Merged via the queue into main with commit 14b0b41 Jul 1, 2026
21 checks passed
@waynesun09 waynesun09 deleted the fix-org-mode-readme-link branch July 1, 2026 15:40
@fullsend-ai-retro

fullsend-ai-retro Bot commented Jul 1, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 3:44 PM UTC · Completed 3:50 PM UTC
Commit: ab013ad · View workflow run →

@fullsend-ai-retro

Copy link
Copy Markdown

Retro: PR #2767 — docs: revert hardcoded getting-started link to README.md

What happened: PR #2767 was a trivial 1-line documentation change by Wayne Sun, reverting a hardcoded ../getting-started/ link back to the canonical README.md reference in docs/guides/getting-started/org-mode.md, enabled by a markdown-it rewrite rule added in PR #2765.

Timeline:

  1. PR opened at 20:10 UTC on June 29 with commit d5b8ecc
  2. First review run (20:14–20:23 UTC): approved with a low-severity suggestion to update operations.md for link consistency
  3. ready-for-merge label applied at 20:23 UTC
  4. Author force-pushed at 23:03 UTC (commit ab013ad — likely a rebase or amend, same content)
  5. Force push triggered second review run (23:07–23:16 UTC): approved again with the same finding
  6. Human reviewer rh-hemartin approved at 09:04 UTC on June 30
  7. PR merged on July 1

Assessment: The workflow performed correctly. The double review was caused by a force push triggering the pull_request_target synchronize event — expected platform behavior. The review quality was appropriate: the low-severity consistency finding about operations.md link patterns was relevant and actionable. The human review added no findings beyond the bot's, suggesting the bot's coverage was adequate for this change type.

Improvement areas considered but already tracked:

No new proposals are warranted — all identified improvement opportunities are already captured in the existing issue backlog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/docs User-facing documentation ready-for-merge All reviewers approved — ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants