chatGPTBox icon indicating copy to clipboard operation
chatGPTBox copied to clipboard

add FAQ section in README based on some common issues

Open Danielweng0902 opened this issue 7 months ago • 12 comments

  • Added "Frequently Asked Questions (FAQ)" section to README.
  • Covers common problems such as:
    • Login issues with Brave browser (#794)
    • Google Gemini integration not working properly (#786, #757)
    • Bilibili site compatibility issues (#732, #703)
  • Each FAQ entry includes possible causes and suggested solutions.

If there are additional common issues in the future, this FAQ section can be further updated.

Danielweng0902 avatar May 30 '25 15:05 Danielweng0902

Hi @PeterDaveHello I created a new pull request https://github.com/josStorer/chatGPTBox/pull/860 to add FAQ based on the common issues in https://github.com/josStorer/chatGPTBox/issues Feel free to review it when you have time and let me know your thoughts.

Danielweng0902 avatar May 30 '25 15:05 Danielweng0902

Hi @Daniel930902,

I'm ony an active contributor to chatGPTBox without direct permission to review the changes, but maybe you can use tools like markdownlint to ensure the markdown format before the project maintainer can review it ;)

PeterDaveHello avatar May 31 '25 14:05 PeterDaveHello

Sorry for the delay due to various reasons. I think I will have time recently to release an update for chatGPTBox, and I will handle this PR later.

josStorer avatar May 31 '25 14:05 josStorer

@josStorer Happy to see you back! I'm excited to see the current updates addressed and to contribute further based on them. I also suggest exploring a more efficient collaboration model for chatGPTBox, like setting up a GitHub organization and inviting contributors with limited, essential permissions. This is an amazing project, and I truly hope it continues to flourish over the long term. Thank you so much!

PeterDaveHello avatar May 31 '25 14:05 PeterDaveHello

@PeterDaveHello Hello, I have already invited you as a collaborator for the repository. If you don't mind, you can help the project handle some issues, while I will be responsible for the release and submission for store review. I will also continue to update it when I have time.

I fully understand how frustrating it is for many users not to receive timely updates due to my personal busyness.

I feel that when I have some free time, I need to use wxt.dev and TypeScript to conduct a large-scale refactoring of the repository and implement automated store submissions, so that more collaborators can get involved.

josStorer avatar May 31 '25 14:05 josStorer

@josStorer Great, I saw the invitation. I'll look into handling some issues. However, given the limitations in functionality and role permissions, I'd respectfully recommend managing this through a GitHub Org instead. From my experience, this approach tends to be simpler and more effective. What do you think?

PeterDaveHello avatar May 31 '25 14:05 PeterDaveHello

@josStorer By the way, I've accepted your invitation, but it seems I don't have permissions yet, like tagging, closing, merging, or requesting reviews. This discussion is a bit beyond the scope of this PR. Maybe we should discuss elsewhere. If you're available, we can quickly chat via X (Twitter) DM as we have before.

PeterDaveHello avatar May 31 '25 14:05 PeterDaveHello

@PeterDaveHello Alright, I will transfer this repository to an organization account tomorrow.

josStorer avatar May 31 '25 14:05 josStorer

/review

PeterDaveHello avatar Jun 02 '25 18:06 PeterDaveHello

Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ❌

732 - Not compliant

Non-compliant requirements:

• Fix issue with Bilibili video summary where subtitles are not fully extracted

Requires further human verification:

• The PR only adds documentation about the issue but doesn't implement a fix

703 - Not compliant

Non-compliant requirements:

• Fix Bilibili video summary window in dark mode where markdown title text appears black and is unreadable

Requires further human verification:

• The PR only adds documentation about the issue but doesn't implement a fix

757 - Not compliant

Non-compliant requirements:

• Fix bugs with the web version of Gemini integration

Requires further human verification:

• The PR only adds documentation about the issue but doesn't implement a fix

794 - Not compliant

Non-compliant requirements:

• Fix login issue with Brave browser where users cannot log in to ChatGPT.com with the extension active

Requires further human verification:

• The PR only adds documentation about the issue but doesn't implement a fix

786 - Not compliant

Non-compliant requirements:

• Fix Google's Gemini bot integration that is not working at all

Requires further human verification:

• The PR only adds documentation about the issue but doesn't implement a fix

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Formatting Issue

There's a spacing issue in the Markdown formatting for "Possible causes: " and "Possible solutions: " which has an extra space before the closing asterisk, causing improper rendering.

**Possible causes: **

Inconsistent Formatting

The FAQ section has inconsistent capitalization and punctuation in the solutions sections. Some bullet points start with lowercase letters while others start with uppercase.

**Solution:**
1. disable the extension
2. Log in
3. Re-enable it

Incomplete Information

The Gemini section states "Sometimes working" without proper sentence structure or explanation, making it unclear what this means to users.

Sometimes working
**not officially fixed yet**

qodo-code-review[bot] avatar Jun 02 '25 18:06 qodo-code-review[bot]

/improve

PeterDaveHello avatar Jun 02 '25 18:06 PeterDaveHello

Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here.

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Impact
General
Fix Markdown formatting
Suggestion Impact:The commit removed the extra space before the closing asterisks, correcting the bold formatting for "Possible causes:" (and similarly for other headings).

code diff:

-**Possible causes: **
+**Possible causes:**

Fix the Markdown formatting for the "Possible causes" heading. There's an extra
space between the asterisks and the text which breaks the bold formatting in
Markdown.

README.md [167]

-**Possible causes: **
+**Possible causes:**
 
 - Google Gemini's web interface/API may have changed or is unstable.

[To ensure code accuracy, apply this suggestion manually]

Suggestion importance[1-10]: 3

__

Why: The suggestion correctly identifies a Markdown formatting issue where the extra space in **Possible causes: ** breaks bold formatting. This is a minor but valid formatting fix.

Low
Fix text formatting
Suggestion Impact:The commit corrected "**Possible solutions: **" to "**Possible solutions:**" and inserted a space in "settings. This", matching the suggested formatting fixes.

code diff:

-**Possible solutions: **
-
-
-- Try enabling floating window mode in ChatGPTBox settings.This works better on sites that block side panels.
+**Possible solutions:**
+
+- Try enabling floating window mode in ChatGPTBox settings. This works better on sites that block side panels.

Fix the Markdown formatting for "Possible solutions" and add a space after the
period for better readability between sentences in the first bullet point.

README.md [203-206]

-**Possible solutions: **
+**Possible solutions:**
 
 
-- Try enabling floating window mode in ChatGPTBox settings.This works better on sites that block side panels.
+- Try enabling floating window mode in ChatGPTBox settings. This works better on sites that block side panels.

[Suggestion processed]

Suggestion importance[1-10]: 3

__

Why: The suggestion fixes two minor formatting issues: correcting the bold Markdown syntax in **Possible solutions: ** and adding proper spacing in settings.This. These are valid but minor readability improvements.

Low
General
Fix Markdown formatting
Suggestion Impact:The commit removed the extra space before the closing asterisks, correcting the bold formatting for "Possible causes:" (and similarly for other headings).

code diff:

-**Possible causes: **
+**Possible causes:**

Fix the Markdown formatting for the "Possible causes" heading in the Bilibili
section. The current format with spaces between asterisks and text breaks the
bold formatting in Markdown.

README.md [191-193]

-** Possible causes: **
+**Possible causes:**
 
 - Bilibili uses dynamic page loading (SPA) and complex DOM structure, which may interfere with the extension's side panel injection.
  • [ ] Apply / Chat
Suggestion importance[1-10]: 4

__

Why: The suggestion correctly identifies a markdown formatting issue where spaces between asterisks break bold formatting. This is a minor but valid improvement to documentation readability.

Low
General
Fix Markdown formatting
Suggestion Impact:The commit removed the extra space before the closing asterisks, correcting the bold formatting for "Possible causes:" (and similarly for other headings).

code diff:

-**Possible causes: **
+**Possible causes:**

Fix the Markdown formatting for the "Possible causes" heading in the Google
Gemini section. There's an extra space between the asterisks and the text which
breaks the bold formatting in Markdown.

README.md [167]

-**Possible causes: **
+**Possible causes:**
 
 - Google Gemini's web interface/API may have changed or is unstable.

[To ensure code accuracy, apply this suggestion manually]

Suggestion importance[1-10]: 4

__

Why: The suggestion correctly identifies a markdown formatting issue where an extra space before the closing asterisks breaks bold formatting. This is a valid but minor improvement to documentation readability.

Low
  • [ ] Update

qodo-code-review[bot] avatar Jun 02 '25 18:06 qodo-code-review[bot]

[!NOTE]

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

README.md was updated with two inserted Frequently Asked Questions (FAQ) sections documenting issues and step-by-step solutions for Brave login, Google Gemini, and Bilibili. Changes are documentation-only and include unresolved Git conflict markers; no code or exported entities were modified.

Changes

Cohort / File(s) Summary
FAQ Documentation
README.md
Added two FAQ sections (inserted in separate locations) covering Brave login, Google Gemini, and Bilibili issues; each entry includes causes, step-by-step remedies, and references to related issues. Documentation-only additions; no functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Verify FAQ content accuracy and clarity
  • Confirm referenced issue links resolve correctly
  • Check README formatting and removal of unresolved conflict markers

Poem

🐇 I hopped through README's bright glade,

Found FAQs placed where answers stayed.
I chewed the conflicts, cleared the way—
Now docs hum tidy through the day. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly and clearly describes the main change: adding a FAQ section to README based on common issues, which aligns with the file summary and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e717d1cc543d702541dbcbf0786306bc8dcf18e7 and 78355e539d29d2d3f5bb0a69c1d29606bc3cb6e4.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

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.

coderabbitai[bot] avatar Nov 17 '25 10:11 coderabbitai[bot]

Hi, sorry for the long waiting. I've fixed this as suggested, and hope to finish it once and for all. Feel free to review it when you have time and let me know your thoughts.

Danielweng0902 avatar Nov 19 '25 05:11 Danielweng0902