Skip to content

docs: point README doc links to folder#4294

Open
Project516 wants to merge 1 commit into
pingdotgg:mainfrom
Project516:patch-1
Open

docs: point README doc links to folder#4294
Project516 wants to merge 1 commit into
pingdotgg:mainfrom
Project516:patch-1

Conversation

@Project516

@Project516 Project516 commented Jul 22, 2026

Copy link
Copy Markdown

What Changed

updated the links in the readme to point to the folder and not to a direct file.

Why

If someone is looking at the docs and looking for what providers are supported and how to configure them, the current setup with the link going straight to the codex file may confuse them. Moving the link to the folder shows them the available providers

Checklist

  • This PR is small and focused
  • I explained what changed and why

Note

Low Risk
Documentation-only link targets in README; no runtime or build impact.

Overview
Updates the README Documentation section so Provider guides and Operations link to their docs/ directories instead of single files (codex.md and ci.md).

Readers land on the full set of provider and operations docs rather than one arbitrary entry point.

Reviewed by Cursor Bugbot for commit 1d8564c. Bugbot is set up for automated code reviews on this repo. Configure here.

Note

Update README doc links to point to provider and operations directories

Changes two links in README.md from specific files (docs/providers/codex.md and docs/operations/ci.md) to their parent directories (docs/providers and docs/operations).

Macroscope summarized 1d8564c.

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 2ae018a1-1070-41dc-ae4b-1d0365e2fea4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@github-actions github-actions Bot added vouch:unvouched PR author is not yet trusted in the VOUCHED list. size:XS 0-9 changed lines (additions + deletions). labels Jul 22, 2026
@macroscopeapp

macroscopeapp Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Approvability

Verdict: Approved

Documentation-only change updating two README links to point to folders instead of specific files. No runtime impact.

You can customize Macroscope's approvability policy. Learn more.

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

Labels

size:XS 0-9 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant