docs: point README doc links to folder#4294
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
ApprovabilityVerdict: 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. |
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
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.mdandci.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.mdanddocs/operations/ci.md) to their parent directories (docs/providersanddocs/operations).Macroscope summarized 1d8564c.