Skip to content

#225 - Serve benchmarks overview at /benchmarks/#226

Merged
RamyaGuru merged 1 commit into
mainfrom
docs/benchmarks-overview-url
Jul 15, 2026
Merged

#225 - Serve benchmarks overview at /benchmarks/#226
RamyaGuru merged 1 commit into
mainfrom
docs/benchmarks-overview-url

Conversation

@RamyaGuru

@RamyaGuru RamyaGuru commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Closes #225
Rename docs/benchmarks/benchmarks.md to index.md so the overview page is served at benchmarks/ instead of benchmarks/benchmarks/. Update the mkdocs nav, cross-doc links, published README URLs, footer link, and the AGENTS.md doc-path reference accordingly.

Assisted-by: Claude Opus 4.8 (1M context) noreply@anthropic.com

Rename docs/benchmarks/benchmarks.md to index.md so the overview page
is served at benchmarks/ instead of benchmarks/benchmarks/. Update the
mkdocs nav, cross-doc links, published README URLs, footer link, and
the AGENTS.md doc-path reference accordingly.

Assisted-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Ramya Gurunathan <rgurunathan@nvidia.com>
@greptile-apps

greptile-apps Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Renames docs/benchmarks/benchmarks.md to docs/benchmarks/index.md so MkDocs serves the overview at /benchmarks/ instead of the redundant /benchmarks/benchmarks/. All downstream references are updated consistently.

  • mkdocs.yml nav, docs/landing/footer.html, and every relative cross-link in docs/ are updated to point at index.md.
  • Published GitHub Pages URLs in README.md and the doc-path entry in AGENTS.md are corrected to drop the extra path segment.
  • A repo-wide search finds no remaining references to the old benchmarks/benchmarks path.

Confidence Score: 5/5

Pure documentation rename with no code changes; all cross-references and external URLs have been updated and no stale links remain.

The change is a single file rename accompanied by exhaustive reference updates across every file that linked to the old path. The commit carries a valid DCO sign-off and follows the required # - <title> format. No logic, build system, or API surface is touched.

No files require special attention.

Important Files Changed

Filename Overview
docs/benchmarks/index.md Renamed from benchmarks.md to index.md; content unchanged — this rename is the core goal of the PR
mkdocs.yml Nav entry updated from benchmarks/benchmarks.md to benchmarks/index.md; correct change
README.md Two published GitHub Pages URLs updated from /benchmarks/benchmarks/ to /benchmarks/; correct
AGENTS.md Doc-path reference updated from benchmarks/benchmarks.md to benchmarks/index.md; correct
docs/landing/footer.html Footer href updated from benchmarks/benchmarks/ to benchmarks/; correct
docs/benchmarks/raw_benchmarking.md Two relative links updated from benchmarks.md to index.md; correct
docs/benchmarks/socket_benchmarking.md Footer nav link updated from benchmarks.md to index.md; correct
docs/getting-started.md Relative link updated from benchmarks/benchmarks.md to benchmarks/index.md; correct
docs/tutorials/configuration-walkthrough.md Relative link updated from ../benchmarks/benchmarks.md to ../benchmarks/index.md; correct
docs/tutorials/system_configuration.md Three relative links updated from ../benchmarks/benchmarks.md to ../benchmarks/index.md; correct

Reviews (1): Last reviewed commit: "#225 - Serve benchmarks overview at /ben..." | Re-trigger Greptile

@RamyaGuru
RamyaGuru merged commit 04929f9 into main Jul 15, 2026
3 checks passed
@RamyaGuru
RamyaGuru deleted the docs/benchmarks-overview-url branch July 16, 2026 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] URL fix for Benchmarking Overview Page

1 participant