Skip to content

add FAQ section in README based on some common issues #860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Daniel930902
Copy link


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

@Daniel930902
Copy link
Author

Hi @PeterDaveHello
I created a new pull request #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.

@PeterDaveHello
Copy link
Member

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**


Copy link
Member

Choose a reason for hiding this comment

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

This line seems to have an extra blank space


### Cannot login to ChatGPT.com with this extension active using Brave web browser

#### [#794]( https://github.com/josStorer/chatGPTBox/issues/794 )
Copy link
Member

Choose a reason for hiding this comment

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

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.

@josStorer
Copy link
Member

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.

@PeterDaveHello
Copy link
Member

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

@josStorer
Copy link
Member

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

@PeterDaveHello
Copy link
Member

@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
Copy link
Member

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

@josStorer
Copy link
Member

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

@PeterDaveHello PeterDaveHello requested a review from Copilot May 31, 2025 20:18
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

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.


### Cannot login to ChatGPT.com with this extension active using Brave web browser

#### [#794]( https://github.com/josStorer/chatGPTBox/issues/794 )
Copy link
Preview

Copilot AI May 31, 2025

Choose a reason for hiding this comment

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

Remove the space before the URL in the Markdown link so it reads [#794](https://github.com/josStorer/chatGPTBox/issues/794) and renders correctly.

Copilot uses AI. Check for mistakes.


### Google Gemini not working

#### [#786]( https://github.com/josStorer/chatGPTBox/issues/786 ), [#757]( https://github.com/josStorer/chatGPTBox/issues/757 )
Copy link
Preview

Copilot AI May 31, 2025

Choose a reason for hiding this comment

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

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

Copilot uses AI. Check for mistakes.


### bilibili not working correctly

#### [#732]( https://github.com/josStorer/chatGPTBox/issues/732 ), [#703]( https://github.com/josStorer/chatGPTBox/issues/703 )
Copy link
Preview

Copilot AI May 31, 2025

Choose a reason for hiding this comment

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

Remove the space before each URL in the issue links so they render properly, e.g. [#732](https://github.com/josStorer/chatGPTBox/issues/732).

Copilot uses AI. Check for mistakes.

**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.
Copy link
Preview

Copilot AI May 31, 2025

Choose a reason for hiding this comment

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

Add a space before the opening parenthesis and remove the extra space before the closing parenthesis: protections (shields, blocking scripts or cookies).

Copilot uses AI. Check for mistakes.

**Possible solutions: **


- Try enabling floating window mode in ChatGPTBox settings.This works better on sites that block side panels.
Copy link
Preview

Copilot AI May 31, 2025

Choose a reason for hiding this comment

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

Insert a space after the period so it reads settings. This works better on sites that block side panels.

Copilot uses AI. Check for mistakes.




### bilibili not working correctly
Copy link
Preview

Copilot AI May 31, 2025

Choose a reason for hiding this comment

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

Capitalize “Bilibili” in the heading for consistency and as a proper noun: ### Bilibili not working correctly.

Copilot uses AI. Check for mistakes.

Sometimes working
**not officially fixed yet**

**Possible causes: **
Copy link
Preview

Copilot AI May 31, 2025

Choose a reason for hiding this comment

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

Standardize bold formatting by removing trailing spaces inside the markers, for example use **Possible causes:** instead of **Possible causes: **.

Copilot uses AI. Check for mistakes.

@PeterDaveHello
Copy link
Member

/review

Copy link

qodo-merge-pro bot commented Jun 2, 2025

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**

@PeterDaveHello
Copy link
Member

/improve

Copy link

qodo-merge-pro bot commented Jun 2, 2025

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

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

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.
  • Apply / Chat
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

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

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
  • More

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants