Skip to content

docs: fix broken links in the core docs index and wren READMEs - #2866

Open
pratikgx wants to merge 1 commit into
Canner:mainfrom
pratikgx:docs-fix-core-index-links
Open

pratikgx wants to merge 1 commit into
Canner:mainfrom
pratikgx:docs-fix-core-index-links

Conversation

@pratikgx

@pratikgx pratikgx commented Nov 13, 2026 •

Copy link
Copy Markdown

Summary

Fixes five links that point to pages or files that have moved:

  • core/wren/README.md: the Cube guide link docs/core/guides/modeling/cube.md -> docs/core/guides/cubes.md
  • core/wren-core/wren-example/README.md: examples/plan_to-sql.rs -> examples/plan-sql.rs, with the link text updated to match
  • docs/core/README.md:
    • "Connect Your Database": get_started/connect.md -> guides/connect.md
    • "Architecture": concepts/architecture.md -> reference/architecture.md
    • "Models": guides/modeling/model.md -> guides/model.md

Docs only. The other stale index entries in docs/core/README.md (for example "Memory", "Profiles" and the guides/modeling/ pages) don't have an obvious one-to-one replacement after the docs restructure, so I've left those for you to decide.

Summary by CodeRabbit

  • Documentation
    • Updated README links to point to the correct SQL planning example and cube guide.
    • Corrected links for connecting a database, architecture documentation, and model guides.

@github-actions github-actions Bot added documentation Improvements or additions to documentation python Pull requests that update Python code rust Pull requests that update rust code core labels Nov 13, 2026
@coderabbitai

coderabbitai Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

Three README files now link to updated paths for the plan-sql example, the cube guide, and core documentation pages.

Changes

README link updates

Layer / File(s) Summary
README link target updates
core/wren-core/wren-example/README.md, core/wren/README.md, docs/core/README.md
Five links now point to updated example and guide documentation paths.

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Suggested reviewers: goldmedal

Merge Risk: Minimal · up to 49705

This is a docs-only change that fixes stale links. It has no runtime impact and is ready to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the change: it fixes broken links in the core docs index and the wren READMEs. The raw summary shows the same five link updates across the three files. The title is specific and matche…
Description check Passed The description follows the template's Summary section. It lists each of the five link fixes with old and new targets and states the change is docs only. The template's other sections are 'What failur…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the change: it fixes broken links in the core docs index and the wren READMEs. The raw summary shows the same five link updates across the three files. The title is specific and matches the changeset. It uses the docs: prefix, which fits a docs-only change.

Full details: Description check

Explanation

The description follows the template's Summary section. It lists each of the five link fixes with old and new targets and states the change is docs only. The template's other sections are 'What failure does this repair?', 'How is it tested?', and 'Duplicate check'. The template says a docs tweak needs only the summary, so the missing sections are acceptable for this PR. The author also explains which stale entries were left out and why.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

A rabbit checks each path with care
The guide links lead from here to there
The example link is fresh and clear
Five paths now point where pages appear
The rabbit hops along, content in tow

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2c6de9be-fc6d-469c-b9ce-19316b446504
Commits

Reviewing files that changed from the base of the PR and between 75035ad and 497053a.

Files selected for processing: 3

  • core/wren-core/wren-example/README.md
  • core/wren/README.md
  • docs/core/README.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

This branch has not been deployed

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

Labels

core documentation Improvements or additions to documentation python Pull requests that update Python code rust Pull requests that update rust code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant