Skip to content

Fix typo in authentication FAQ section #1099

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.

Sign up for GitHub

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

Merged
msukkari merged 1 commit into from
Apr 8, 2026
Merged

Fix typo in authentication FAQ section #1099

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/configuration/auth/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ This page covers a range of frequently asked questions about Sourcebot's built-i

<Accordion title="How does Sourcebot implement authentication?">
Sourcebot uses [Auth.js](https://authjs.dev/) as its underlying authentication framework. Auth.js provides authentication providers
(credientials, Google, GitHub, etc) and an interface to enable user registration and log in. Internally, Auth.js uses JWT to provide
(credentials, Google, GitHub, etc) and an interface to enable user registration and log in. Internally, Auth.js uses JWT to provide
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Wrap technical values in inline code in this sentence.

Please format provider names as inline code to match docs style.

Suggested edit 
-    (credentials, Google, GitHub, etc) and an interface to enable user registration and log in. Internally, Auth.js uses JWT to provide
+    (`credentials`, `Google`, `GitHub`, etc) and an interface to enable user registration and log in. Internally, Auth.js uses `JWT` to provide

As per coding guidelines, "Use bold for UI elements and inline code for technical values".

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(credentials, Google, GitHub, etc) and an interface to enable user registration and log in. Internally, Auth.js uses JWT to provide
(`credentials`, `Google`, `GitHub`, etc) and an interface to enable user registration and log in. Internally, Auth.js uses `JWT` to provide
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/docs/configuration/auth/faq.mdx` at line 39, Update the sentence
containing "(credentials, Google, GitHub, etc) and an interface to enable user
registration and log in. Internally, Auth.js uses JWT to provide" by wrapping
the technical provider names and values in inline code formatting (e.g.,
`credentials`, `Google`, `GitHub`, `JWT`) so they follow the docs style; keep
the surrounding punctuation and wording unchanged and ensure only the
provider/technical tokens are converted to inline code.

Sourcebot secure and reliable information about user authentication.
</Accordion>
</AccordionGroup>

Have a question that's not answered here? Submit an issue on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) and we'll get back to you as soon as we can.
Have a question that's not answered here? Submit an issue on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) and we'll get back to you as soon as we can.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use second person and present tense for the closing CTA.

This line switches to first person and future tense. Please rewrite in second person/present tense.

Suggested edit 
-Have a question that's not answered here? Submit an issue on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) and we'll get back to you as soon as we can.
+If your question is not answered here, submit an issue on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) to get help.

As per coding guidelines, "Write in second person and present tense. Keep sentences short."

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Have a question that's not answered here? Submit an issue on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) and we'll get back to you as soon as we can.
If your question is not answered here, submit an issue on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) to get help.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/docs/configuration/auth/faq.mdx` at line 44, Replace the closing CTA
sentence "Have a question that's not answered here? Submit an issue on
[GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) and we'll
get back to you as soon as we can." with a second-person, present-tense, short
version (e.g., "Have a question that's not answered here? Submit an issue on
GitHub and get a response as soon as possible.") so the message addresses the
reader directly and uses present tense; update the line in
docs/docs/configuration/auth/faq.mdx accordingly.