Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

docs: Fix cursor/course typos and other documentation errors#1505

Merged
yorukot merged 4 commits into
yorukot:mainyorukot/superfile:mainfrom
KristianHolme:cursor/fix-cursor-course-typos-98e2KristianHolme/superfile:cursor/fix-cursor-course-typos-98e2Copy head branch name to clipboard
Jul 22, 2026
Merged

docs: Fix cursor/course typos and other documentation errors#1505
yorukot merged 4 commits into
yorukot:mainyorukot/superfile:mainfrom
KristianHolme:cursor/fix-cursor-course-typos-98e2KristianHolme/superfile:cursor/fix-cursor-course-typos-98e2Copy head branch name to clipboard

Conversation

@KristianHolme

@KristianHolme KristianHolme commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

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

  • Documentation
    • Updated README Windows section anchors/headings and corrected wording across installation, tutorial, troubleshooting, hotkey lists, and custom theme guides (including TOML guidance and corrected link paths), plus language/formatting fixes.
  • Bug Fixes
    • Refined user-facing text for the terminal-size warning, preview-related ANSI conversion error messaging, config-repair success output, and several help/prompt hotkey and command descriptions.
  • Tests
    • Updated a render-output expectation to match the latest displayed suggestion text.

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>
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

🎉 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.
That’s totally normal and part of the process. Don’t worry, we’ll help guide you through it.

👉 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!

@github-actions github-actions Bot added awaiting pr review documentation Improvements or additions to documentation test related PR / Issue related to testcases or testing in general. website Website-related changes and removed awaiting pr review labels Jul 1, 2026
@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

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

Run ID: 840698d1-59d4-48fe-9361-27199aaa9970

📥 Commits

Reviewing files that changed from the base of the PR and between 8911b46 and de4b1b9.

📒 Files selected for processing (1)
  • website/src/content/docs/list/hotkey-list.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
  • website/src/content/docs/list/hotkey-list.mdx

📝 Walkthrough

Walkthrough

This 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.

Changes

Text and copy corrections

Layer / File(s) Summary
Go source string corrections
src/internal/common/predefined_variable.go, src/internal/model_render.go, src/internal/ui/helpmenu/data.go, src/internal/ui/preview/render.go, src/internal/ui/prompt/consts.go, src/internal/ui/prompt/model_test.go, src/pkg/utils/*
Updates error, warning, hotkey, command, and TOML repair strings, with related test expectations changed to match.
README anchor and heading fix
README.md
Renames the Windows TOC anchor and matching subsection heading from “Window” to “Windows”.
English documentation wording and link fixes
website/src/content/docs/..., CONTRIBUTING.md
Rewords documentation, fixes capitalization and spacing, and updates contribution links, source references, and theme checklist labels.
Traditional Chinese documentation corrections
website/src/content/docs/zh-tw/...
Updates a contribution link and corrects wording plus a referenced source path.

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

Possibly related PRs

Suggested labels: documentation, website

Suggested reviewers: lazysegtree

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the PR’s main theme of fixing typos and documentation text, even though it doesn’t mention the broader UI string updates.
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.

@KristianHolme KristianHolme changed the title Fix cursor/course typos and other documentation errors docs: Fix cursor/course typos and other documentation errors Jul 1, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0a4336a and fda2032.

📒 Files selected for processing (20)
  • README.md
  • src/internal/common/predefined_variable.go
  • src/internal/model_render.go
  • src/internal/ui/helpmenu/data.go
  • src/internal/ui/preview/render.go
  • src/internal/ui/prompt/consts.go
  • src/pkg/utils/file_utils.go
  • src/pkg/utils/file_utils_test.go
  • website/src/content/docs/configure/custom-theme.mdx
  • website/src/content/docs/configure/superfile-config.mdx
  • website/src/content/docs/contribute/how-to-contribute.md
  • website/src/content/docs/contribute/implementation-info.md
  • website/src/content/docs/getting-started/image-preview.md
  • website/src/content/docs/getting-started/installation.mdx
  • website/src/content/docs/getting-started/tutorial.mdx
  • website/src/content/docs/list/hotkey-list.mdx
  • website/src/content/docs/overview.md
  • website/src/content/docs/troubleshooting.md
  • website/src/content/docs/zh-tw/configure/custom-theme.mdx
  • website/src/content/docs/zh-tw/contribute/implementation-info.md

Comment thread website/src/content/docs/contribute/how-to-contribute.md Outdated
Comment thread website/src/content/docs/contribute/implementation-info.md Outdated
Comment thread website/src/content/docs/zh-tw/contribute/implementation-info.md Outdated
cursoragent and others added 2 commits July 1, 2026 11:19
- 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>
@yorukot

yorukot commented Jul 22, 2026

Copy link
Copy Markdown
Owner

Can you fix the web Prettier? Thanks!

@yorukot yorukot left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Thanks for your contribution!

@yorukot
yorukot merged commit df46a7c into yorukot:main Jul 22, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation test related PR / Issue related to testcases or testing in general. website Website-related changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.