update editUrl to correctly link to curriculum files#5
Open
DRK28122006 wants to merge 2 commits into
Open
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe Docusaurus documentation preset now generates GitHub edit links for individual curriculum documents instead of using one static repository URL. ChangesDocumentation edit links
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated the
editUrlconfiguration indocusaurus.config.tsto 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
editUrlwas not correctly mapping to the../curriculumdirectory, leading to broken links (404 errors) when users attempted to edit documentation.Changes
editUrlstring with a dynamic function({ docPath }) => ....https://github.com/Flow-Research/learn/edit/main/curriculum/${docPath}.Verification
npm run start.curriculum/products/jarvis.md.Summary by CodeRabbit