Skip to content

docs: fix typo in the website, added some introduction text#44

Merged
snipsnipsnip merged 1 commit intoexteditor:mainfrom
snipsnipsnip:website-typo
Oct 20, 2025
Merged

docs: fix typo in the website, added some introduction text#44
snipsnipsnip merged 1 commit intoexteditor:mainfrom
snipsnipsnip:website-typo

Conversation

@snipsnipsnip
Copy link
Copy Markdown
Member

@snipsnipsnip snipsnipsnip commented Oct 20, 2025

Summary by CodeRabbit

  • Documentation

    • Enhanced site homepage with historical context and reference to the original GhostText browser extension, helping users understand the project's background and evolution.
  • Chores

    • Corrected website resource reference path.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 20, 2025

Warning

Rate limit exceeded

@snipsnipsnip has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 22 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ae67a7e and 0350d4b.

📒 Files selected for processing (2)
  • .github/site/coverpage.md (1 hunks)
  • .github/site/homepage.md (1 hunks)
📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Enhanced site homepage with historical context and reference to the original GhostText browser extension, helping users understand the project's background and evolution.
    • Added comprehensive setup instructions explaining that users must install and configure a corresponding text editor plugin to enable text synchronization functionality.
  • Chores

    • Corrected website resource reference path.

Walkthrough

Two documentation updates to the site configuration: corrected a logo image path reference and added contextual information about GhostText client-side setup requirements and the original browser add-on.

Changes

Cohort / File(s) Summary
Site Documentation Updates
.github/site/coverpage.md
Updated logo image path from ../ext/blue.svg to ./ext/blue.svg
Site Documentation Updates
.github/site/homepage.md
Added note referencing the original GhostText browser add-on and clarified that GhostText synchronization requires a GhostText server function in the text editor (client-side plugin)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A path corrected, a note now clear,
Documentation dressed for those drawing near.
GhostText's tale, setup laid out right,
Our little edits make everything bright! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request has no description provided by the author. The repository's description template requires multiple sections including current behavior with issue reference, new behavior description, manual testing steps, and a dual-license agreement checkbox. All required sections and information are completely missing, making this a significant gap that prevents reviewers from understanding the context, rationale, and testing approach for the changes. This represents a largely incomplete pull request description that fails to meet the repository's standards. The author must add a complete pull request description following the repository template. At minimum, this should include the "What is the current behavior?" section (with a reference to the related issue), the "What is the new behavior?" section explaining the documentation updates, and steps to verify the changes. The dual-license agreement checkbox should also be marked to indicate agreement with the contribution licensing terms.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title "docs: fix typo in the website, added some introduction text" is related to the actual changes in the pull request. The PR modifies two documentation files: it updates a logo image path in coverpage.md and adds introduction text about GhostText origins and client-side setup in homepage.md. The title accurately captures the introduction text addition and refers to the path fix in coverpage.md, though calling a path reference change a "typo" is somewhat imprecise terminology. Overall, the title clearly communicates that this is a documentation update with fixes and new content, and a teammate scanning history would understand the primary focus is on website documentation improvements.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

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 and usage tips.

@codecov
Copy link
Copy Markdown

codecov bot commented Oct 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.97%. Comparing base (a6a78f5) to head (0350d4b).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
Components Coverage Δ
app 32.47% <ø> (ø)
ghosttext 49.18% <ø> (ø)
infra 44.00% <ø> (ø)

@snipsnipsnip snipsnipsnip changed the title docs: fix typo in website, added some introduction text docs: fix typo in the website, added some introduction text Oct 20, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6a78f5 and ae67a7e.

📒 Files selected for processing (2)
  • .github/site/coverpage.md (1 hunks)
  • .github/site/homepage.md (1 hunks)
🔇 Additional comments (1)
.github/site/coverpage.md (1)

2-2: Logo path reference corrected.

The change from ../ext/blue.svg to ./ext/blue.svg aligns the path with how it's referenced elsewhere in the codebase (e.g., homepage.md line 33) and correctly resolves the typo.

@snipsnipsnip snipsnipsnip added this pull request to the merge queue Oct 20, 2025
Merged via the queue into exteditor:main with commit 7d23553 Oct 20, 2025
8 checks passed
@snipsnipsnip snipsnipsnip deleted the website-typo branch October 20, 2025 14:47
@github-project-automation github-project-automation bot moved this from 📥️Inbox to 🪺Experimental in Ghostbird Issues Oct 20, 2025
@snipsnipsnip snipsnipsnip moved this from 🪺Experimental to ✅Closed in Ghostbird Issues Oct 21, 2025
@snipsnipsnip snipsnipsnip linked an issue Oct 29, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

[Task] Website with some screenshots

1 participant