docs: Fix cursor/course typos and other documentation errors#1505
docs: Fix cursor/course typos and other documentation errors#1505yorukot merged 4 commits intoyorukot:mainyorukot/superfile:mainfrom KristianHolme:cursor/fix-cursor-course-typos-98e2KristianHolme/superfile:cursor/fix-cursor-course-typos-98e2Copy head branch name to clipboard
Conversation
Correct 'course' to 'cursor' in help menu descriptions and align wording with the hotkey list docs. Also fix assorted typos in docs, README, and user-facing UI strings (grammar, broken links, missing punctuation). Co-authored-by: Kristian Holme <KristianHolme@users.noreply.github.com>
|
🎉 Thank you for your first contribution to superfile! We’re really excited to have you here 🙌 A maintainer might ask you to make a few changes before we can merge this PR. 👉 Please also take a moment to review our Contribution Guide If you have any questions, feel free to open a Discussion or just ask in the comments! |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR corrects wording, punctuation, capitalization, anchors, links, and documentation references across Go source strings, the README, and English/Traditional Chinese documentation. No logic or public API changes. ChangesText and copy corrections
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@website/src/content/docs/contribute/how-to-contribute.md`:
- Around line 53-54: The nested bullet under the contribute docs still uses the
misspelled label Processbar, so update that bullet in the markdown list to match
the surrounding Process panel wording. Keep the change localized to the sidebar
items in the contribute guide and ensure the visible text is corrected
everywhere this label appears in that list.
In `@website/src/content/docs/contribute/implementation-info.md`:
- Line 15: The documentation points to the wrong source file for
LoadAllDefaultConfig(); update the reference in this section to the actual
location in src/internal/common/load_config.go so readers can find the
implementation, and leave the function name unchanged to keep the guidance easy
to search for.
In `@website/src/content/docs/zh-tw/contribute/implementation-info.md`:
- Line 15: The documentation points readers to the wrong source file for
LoadAllDefaultConfig(), which is misleading. Update the reference in the
implementation info doc to point to src/internal/common/load_config.go instead
of src/internal/config_function.go, keeping the surrounding description about
embed.FS and writing default configs unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 91be663e-7d9f-44fd-b03a-c5b20e2e4d3b
📒 Files selected for processing (20)
README.mdsrc/internal/common/predefined_variable.gosrc/internal/model_render.gosrc/internal/ui/helpmenu/data.gosrc/internal/ui/preview/render.gosrc/internal/ui/prompt/consts.gosrc/pkg/utils/file_utils.gosrc/pkg/utils/file_utils_test.gowebsite/src/content/docs/configure/custom-theme.mdxwebsite/src/content/docs/configure/superfile-config.mdxwebsite/src/content/docs/contribute/how-to-contribute.mdwebsite/src/content/docs/contribute/implementation-info.mdwebsite/src/content/docs/getting-started/image-preview.mdwebsite/src/content/docs/getting-started/installation.mdxwebsite/src/content/docs/getting-started/tutorial.mdxwebsite/src/content/docs/list/hotkey-list.mdxwebsite/src/content/docs/overview.mdwebsite/src/content/docs/troubleshooting.mdwebsite/src/content/docs/zh-tw/configure/custom-theme.mdxwebsite/src/content/docs/zh-tw/contribute/implementation-info.md
- Use 'Process panel' consistently in contribute screenshot list - Point implementation docs to src/internal/common/load_config.go Co-authored-by: Kristian Holme <KristianHolme@users.noreply.github.com>
Also align Process panel wording in CONTRIBUTING.md with docs. Co-authored-by: Kristian Holme <KristianHolme@users.noreply.github.com>
|
Can you fix the web Prettier? Thanks! |
yorukot
left a comment
There was a problem hiding this comment.
LGTM, Thanks for your contribution!
Correct 'course' to 'cursor' in help menu descriptions and align wording with the hotkey list docs. Also fix assorted typos in docs, README, and user-facing UI strings (grammar, broken links, missing punctuation).
Summary by CodeRabbit