add FAQ section in README based on some common issues #860
Conversation
|
Hi @PeterDaveHello |
|
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 ;) |
|
|
||
| **not officially fixed yet** | ||
|
|
||
|
|
There was a problem hiding this comment.
This line seems to have an extra blank space
README.md
Outdated
|
|
||
| ### Cannot login to ChatGPT.com with this extension active using Brave web browser | ||
|
|
||
| #### [#794]( https://github.com/josStorer/chatGPTBox/issues/794 ) |
There was a problem hiding this comment.
The spaces before and after the URL inside the hyperlink brackets seem unnecessary. Additionally, I'm not sure if it's a good idea to directly use a hyperlink in a heading to link to an issue number.
|
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 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 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 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? |
|
@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 Alright, I will transfer this repository to an organization account tomorrow. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new FAQ section to the README to address common user issues and provide troubleshooting steps based on GitHub discussions.
- Introduces “Frequently Asked Questions” section with three entries covering Brave login, Google Gemini, and Bilibili compatibility.
- Lists possible causes and actionable solutions for each issue.
- Encourages users to file an issue if their problem isn’t covered.
README.md
Outdated
|
|
||
| ### Cannot login to ChatGPT.com with this extension active using Brave web browser | ||
|
|
||
| #### [#794]( https://github.com/josStorer/chatGPTBox/issues/794 ) |
There was a problem hiding this comment.
Remove the space before the URL in the Markdown link so it reads [#794](https://github.com/josStorer/chatGPTBox/issues/794) and renders correctly.
README.md
Outdated
|
|
||
| ### Google Gemini not working | ||
|
|
||
| #### [#786]( https://github.com/josStorer/chatGPTBox/issues/786 ), [#757]( https://github.com/josStorer/chatGPTBox/issues/757 ) |
There was a problem hiding this comment.
Remove the leading space inside each link's parentheses, e.g. [#786](https://github.com/josStorer/chatGPTBox/issues/786) and [#757](https://github.com/josStorer/chatGPTBox/issues/757).
README.md
Outdated
|
|
||
| ### bilibili not working correctly | ||
|
|
||
| #### [#732]( https://github.com/josStorer/chatGPTBox/issues/732 ), [#703]( https://github.com/josStorer/chatGPTBox/issues/703 ) |
There was a problem hiding this comment.
Remove the space before each URL in the issue links so they render properly, e.g. [#732](https://github.com/josStorer/chatGPTBox/issues/732).
| **Possible causes:** | ||
| - The extension modifies some network requests or page content, which may interfere with the ChatGPT.com login flow. | ||
|
|
||
| - Brave browser’s built-in privacy protections( shields, blocking scripts or cookies ) may conflict with the extension. |
There was a problem hiding this comment.
Add a space before the opening parenthesis and remove the extra space before the closing parenthesis: protections (shields, blocking scripts or cookies).
README.md
Outdated
| **Possible solutions: ** | ||
|
|
||
|
|
||
| - Try enabling floating window mode in ChatGPTBox settings.This works better on sites that block side panels. |
There was a problem hiding this comment.
Insert a space after the period so it reads settings. This works better on sites that block side panels.
README.md
Outdated
| Sometimes working | ||
| **not officially fixed yet** | ||
|
|
||
| **Possible causes: ** |
There was a problem hiding this comment.
Standardize bold formatting by removing trailing spaces inside the markers, for example use **Possible causes:** instead of **Possible causes: **.
|
/review |
|
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:
|
|
/improve |
|
Qodo Merge was enabled for this repository. To continue using it, please link your Git account with your Qodo account here. PR Code Suggestions ✨
|
|||||||||||||||||
|
Note Other AI code review bot(s) detectedCodeRabbit 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. WalkthroughREADME.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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
README.md (1)
150-150: Fix spacing in parenthetical phrase.The parenthetical phrase has inconsistent spacing: "protections( shields, blocking scripts or cookies )" should have a space before the opening parenthesis and remove the trailing space. This was flagged in previous review comments and needs correction.
-- Brave browser's built-in privacy protections( shields, blocking scripts or cookies ) may conflict with the extension. +- Brave browser's built-in privacy protections (shields, blocking scripts or cookies) may conflict with the extension.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-06T17:46:04.304Z
Learnt from: PeterDaveHello
Repo: ChatGPTBox-dev/chatGPTBox PR: 886
File: build.mjs:167-175
Timestamp: 2025-09-06T17:46:04.304Z
Learning: For the ChatGPTBox browser extension project, license preservation concerns about third-party dependencies may not be applicable according to the maintainer PeterDaveHello, who indicated this is the "wrong scope" for the project.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.18.1)
README.md
160-160: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (1)
README.md (1)
134-213: Approve FAQ structure and content quality.The FAQ section is well-organized with clear issue descriptions, causes, and solutions. The inclusion of related GitHub issue references provides helpful traceability. The addition effectively addresses the PR objective of documenting common problems.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
150-150: Fix spacing inconsistency around parentheses.Line 150 has uneven spacing:
protections(lacks a space before the opening parenthesis, while there's an extra space before the closing parenthesis and after it.-- Brave browser's built-in privacy protections( shields, blocking scripts or cookies ) may conflict with the extension. +- Brave browser's built-in privacy protections (shields, blocking scripts or cookies) may conflict with the extension.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-06T17:46:04.304Z
Learnt from: PeterDaveHello
Repo: ChatGPTBox-dev/chatGPTBox PR: 886
File: build.mjs:167-175
Timestamp: 2025-09-06T17:46:04.304Z
Learning: For the ChatGPTBox browser extension project, license preservation concerns about third-party dependencies may not be applicable according to the maintainer PeterDaveHello, who indicated this is the "wrong scope" for the project.
Applied to files:
README.md
🪛 LanguageTool
README.md
[style] ~160-~160: Consider using a different verb for a more formal wording.
Context: ... it Note: This issue is not officially fixed yet. ### Google Gemini not working #...
(FIX_RESOLVE)
[style] ~170-~170: Consider using a different verb for a more formal wording.
Context: ...ing Note: This issue is not officially fixed yet. Possible causes: - Google Ge...
(FIX_RESOLVE)
🔇 Additional comments (4)
README.md (4)
134-140: FAQ structure and introduction are clear and helpful.The introductory section effectively explains the FAQ's purpose and directs users to the Issues page for further help. The formatting is clean and accessible.
143-161: Brave browser section is well-structured.The issue reference, possible causes, and solution steps are clearly presented. The note about the issue not being officially fixed adds transparency.
172-190: Google Gemini section provides comprehensive troubleshooting guidance.The possible causes and solutions are thorough and actionable. The note about ongoing work on this issue is appropriately placed.
192-216: Bilibili section is detailed and well-organized.The possible causes accurately describe the technical challenges with the site (SPA, DOM complexity, CSS overrides), and the solutions provide practical workarounds. The section addresses the issues comprehensively.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
150-150: Add space before opening parenthesis.Line 150 has inconsistent spacing:
protections(should beprotections (to maintain consistent punctuation formatting.- Brave browser's built-in privacy protections( shields, blocking scripts or cookies ) may conflict with the extension. + Brave browser's built-in privacy protections (shields, blocking scripts or cookies) may conflict with the extension.Note: Also removed the extra space before the closing parenthesis for consistency.
🧹 Nitpick comments (2)
README.md (2)
160-162: Remove extra blank line and consider more formal phrasing.Line 162 appears to contain an extra blank line. Additionally, the phrasing "is not officially fixed yet" on line 160 could use more formal wording per style guidelines.
Note: This issue is not officially fixed yet. - - ### Google Gemini not workingOptionally, consider more formal phrasing:
-Note: This issue is not officially fixed yet. +Note: This issue remains unresolved.
169-169: Consider more formal phrasing for consistency.Line 169 uses "is not officially fixed yet", which could be more formally worded to match best practices. This is consistent with the suggestion for line 160.
-Note: This issue is not officially fixed yet. +Note: This issue remains unresolved.This change is optional but would provide more formal, concise phrasing.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-06T17:46:04.304Z
Learnt from: PeterDaveHello
Repo: ChatGPTBox-dev/chatGPTBox PR: 886
File: build.mjs:167-175
Timestamp: 2025-09-06T17:46:04.304Z
Learning: For the ChatGPTBox browser extension project, license preservation concerns about third-party dependencies may not be applicable according to the maintainer PeterDaveHello, who indicated this is the "wrong scope" for the project.
Applied to files:
README.md
🪛 LanguageTool
README.md
[style] ~160-~160: Consider using a different verb for a more formal wording.
Context: ... it Note: This issue is not officially fixed yet. ### Google Gemini not working #...
(FIX_RESOLVE)
[style] ~169-~169: Consider using a different verb for a more formal wording.
Context: ...ing Note: This issue is not officially fixed yet. Possible causes: - Google Ge...
(FIX_RESOLVE)
🔇 Additional comments (2)
README.md (2)
134-139: FAQ introduction is clear and helpful.The introductory text effectively frames the FAQ and provides a clear path for users to escalate issues. No concerns here.
191-214: Bilibili section is well-structured with clear guidance.The causes are specific to Bilibili's implementation details, and the solutions are actionable and practical. Good formatting and organization throughout this section.
Danielweng0902
force-pushed
the
chatGPTBox_faq
branch
from
42be2ed to
e717d1c
Compare
|
Hi, sorry for the long waiting. |
Danielweng0902
force-pushed
the
chatGPTBox_faq
branch
from
e717d1c to
78355e5
Compare
3 participants
If there are additional common issues in the future, this FAQ section can be further updated.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.