Skip to content

update editUrl to correctly link to curriculum files#5

Open
DRK28122006 wants to merge 2 commits into
Flow-Research:mainfrom
DRK28122006:main
Open

update editUrl to correctly link to curriculum files#5
DRK28122006 wants to merge 2 commits into
Flow-Research:mainfrom
DRK28122006:main

Conversation

@DRK28122006

@DRK28122006 DRK28122006 commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Updated the editUrl configuration in docusaurus.config.ts to dynamically construct paths. This ensures the "Edit this page" link on the curriculum pages correctly redirects to the corresponding Markdown file in the repository.

Why

Previously, the static editUrl was not correctly mapping to the ../curriculum directory, leading to broken links (404 errors) when users attempted to edit documentation.

Changes

  • docusaurus.config.ts: Replaced the hardcoded static editUrl string with a dynamic function ({ docPath }) => ....
  • The new path construction specifically targets https://github.com/Flow-Research/learn/edit/main/curriculum/${docPath}.

Verification

  • Verified locally using npm run start.
  • Clicked "Edit this page" on the Jarvis documentation page.
  • Confirmed the link correctly redirects to the GitHub edit interface for curriculum/products/jarvis.md.

Summary by CodeRabbit

  • Documentation
    • Updated documentation edit links to open the corresponding source file directly, making it easier to suggest changes.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 754421e5-e9f2-4282-8607-5e8e2f9d3b2d

📥 Commits

Reviewing files that changed from the base of the PR and between f2fb926 and b867967.

📒 Files selected for processing (1)
  • website/docusaurus.config.ts

📝 Walkthrough

Walkthrough

The Docusaurus documentation preset now generates GitHub edit links for individual curriculum documents instead of using one static repository URL.

Changes

Documentation edit links

Layer / File(s) Summary
Configure per-document edit URLs
website/docusaurus.config.ts
docs.editUrl now uses each document path to target the matching file under edit/main/curriculum/.

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

Suggested reviewers: creativebash

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: fixing Docusaurus editUrl links for curriculum files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ 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.

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.

1 participant