docs: standardise documentation filenames on kebab-case (Closes #606)#631
docs: standardise documentation filenames on kebab-case (Closes #606)#631SakethSumanBathini wants to merge 1 commit into
Conversation
|
@SakethSumanBathini is attempting to deploy a commit to the sreerevanth's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
Warning Review limit reached
Next review available in: 50 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (9)
✨ 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 |
🧪 PR Test Results
Python 3.12 · commit 6b2d099 |
SHAURYASANYAL3
left a comment
There was a problem hiding this comment.
Hi! We'd love to get this merged, but it's currently blocked. Please address the following so we can proceed:
- Merge Conflicts: Your branch has conflicts with main. Please pull the latest main, resolve the conflicts, and force-push.
Let us know once you've updated the PR!
|
Hi! We'd love to get this merged, but it's currently blocked. Please address the following so we can proceed:
Let us know once you've updated the PR! |
Action Required (Update)🔹 Merge Conflicts: Please pull main and resolve conflicts. 🔹 Review Feedback: Please address previous review comments. 🔹 CI Failures (fail) - Please check Actions tab. |
|
Hey! It looks like this PR has developed merge conflicts with the main branch. Please rebase and resolve the conflicts within the next 48 hours, otherwise we'll have to close this PR. |
f023043 to
6b2d099
Compare
|
@SHAURYASANYAL3 rebased — conflicts resolved and the branch is now on current The conflict was in Re-verified after the rebase:
The diff is unchanged in shape: 9 files, +14/−14. The ruff failure reported earlier was the same stale-base problem as #630 — #567 broke it on The remaining red check is Vercel's "authorization required to deploy", which needs a maintainer to |
|
The 48-hour compliance window has expired without conflict resolution. Closing to keep the queue clean. |
|
@SHAURYASANYAL3 The ruff failure isn't from this PR, and rebasing won't clear it — This PR renames six markdown files in Running the CI command on a clean checkout of Byte-for-byte the same as the CI log. That file was added today by #669 ( Two defects, both trivial: a list comprehension ruff wants on one line, and a Happy to open a one-commit PR fixing it on On the merge conflicts: the branch was rebased onto current main two days ago and |
|
Reviewed again. This PR just renames legacy docs/ files. We just completely rebuilt the documentation on the GitHub Wiki for V2, rendering these local doc files obsolete. Closing permanently (YAGNI). |
Closes #606
Summary
Renames the six non-kebab-case files in
docs/and updates every reference to them.API-reference.mdapi-reference.mdTROUBLESHOOTING.mdtroubleshooting.mdarchitecture_detailed.mdarchitecture-detailed.mdcustom_adapters_tutorial.mdcustom-adapters-tutorial.mddeveloper_setup.mddeveloper-setup.mdgetting_started_extended.mdgetting-started-extended.mdAlready kebab-case and untouched:
getting-started.md,architecture.md,index.md,cli/*.md,adapters/*.md.Links updated
mkdocs.yml— 6 nav entriesdocs/architecture.md— 4 inline linksissues.md— path referencesVerified afterwards that no reference to an old filename remains anywhere in the repo, that every
mkdocs.ymlnav entry resolves to a file on disk, and that every internal markdown link indocs/resolves.
Done as real renames
All six show as
R100undergit diff -M, so history is preserved andgit blamestill works. Thatalso means this merges cleanly with in-flight PRs that edit these files — git resolves rename-plus-edit
automatically.
Sequencing
Two of my open PRs touch files renamed here:
docs/API-reference.mddocs/developer_setup.mdGit will handle it, but it's cleanest to merge #604 and #602 first, then this one. Happy to rebase
if you'd rather take this first.
One thing I noticed and left alone
There's a file at the repo root called
how HEAD:__main__.pycontaining git command output — it lookslike someone ran
git show HEAD:__main__.pyand accidentally redirected it into a file. It referencessome of the old doc names, which is how I found it. Not touching it here since it's out of scope, but
it's junk and probably wants deleting.