Skip to content

Conversation

@scherroman
Copy link
Member

@scherroman scherroman commented Jul 26, 2025

Problem

We don't currently have any easily accessible login troubleshooting steps we can share with clients and their employees

Solution

Add new Access > Login troubleshooting section to our docs based roughly on what we had documented in our internal User Authentication Troubleshooting Notion doc

Screen.Recording.2025-07-28.at.6.17.58.PM.mov

Testing

  • Unit tests
  • Integration tests
  • Manual tests

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Added a login troubleshooting guide with step-by-step instructions and screenshots to help users resolve common login issues.
    • Introduced new metadata for the access section and login troubleshooting page.
  • Style

    • Updated headings in FAQ pages to use sentence case for improved consistency.

@scherroman scherroman requested a review from jnfrati July 26, 2025 01:41
@vercel
Copy link

vercel bot commented Jul 26, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
oneleet-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 28, 2025 10:20pm

@coderabbitai
Copy link

coderabbitai bot commented Jul 26, 2025

Walkthrough

A new login troubleshooting guide was added, along with supporting metadata files. Minor heading capitalization changes were made in two FAQ pages. The updates primarily introduce new documentation content and adjust metadata, with no changes to application logic or existing functionality.

Changes

File(s) Change Summary
Metadata update
pages/_meta.ts
Added "access": "Access" to the exported metadata object.
New metadata file
pages/access/_meta.ts
New file; exports { "login-troubleshooting": "Login troubleshooting" } as metadata.
New documentation page
pages/access/login-troubleshooting.mdx
New documentation page providing a step-by-step login troubleshooting guide.
FAQ heading capitalization
pages/oneleet-agent/faq.mdx, pages/penetration-testing/faq.mdx
Changed main heading capitalization from "Frequently Asked Questions" to "Frequently asked questions".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A bunny hopped through docs today,
Adding guides to clear the way.
Troubleshooting tips now shine,
With headings looking quite divine.
Metadata’s neat and new,
FAQ titles got a polish too—
All in a day’s hop, for you! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between c2d745f and 8d1cce3.

📒 Files selected for processing (1)
  • pages/access/login-troubleshooting.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pages/access/login-troubleshooting.mdx
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch roman/add-login-troubleshooting-steps

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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: 0

🧹 Nitpick comments (2)
pages/access/login-troubleshooting.mdx (2)

11-45: Remove manual numbering inside <Steps> items

<Steps> automatically renders an ordered list, so prefixing each heading with “1.”, “2.” … produces duplicated numbers in the rendered output (“1. 1. Try a fresh browser tab”). Keep the headings but drop the manual indices.

-### 1. Try a fresh browser tab
+### Try a fresh browser tab-### 2. Clear your cookies and site data
+### Clear your cookies and site data-### 3. Force a logout
+### Force a logout-### 4. Try an incognito window
+### Try an incognito window-### 5. Try a different browser
+### Try a different browser-### 6. Issues with two-factor authentication
+### Issues with two-factor authentication

61-67: Link the support email for convenience

Plain text support@oneleet.com isn’t automatically clickable in many markdown renderers. Use an explicit mailto: link.

-If none of the above works, reach out to us via your dedicated Slack channel with us or at support@oneleet.com and share the details below so we can help resolve your issue more quickly:
+If none of the above works, reach out via your dedicated Slack channel with us or at [support@oneleet.com](mailto:support@oneleet.com) and share the details below so we can help resolve your issue more quickly:
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between be76243 and c2d745f.

⛔ Files ignored due to path filters (3)
  • public/access/troubleshooting/chrome-clear-cookies-and-site-data-1.png is excluded by !**/*.png
  • public/access/troubleshooting/chrome-clear-cookies-and-site-data-2.png is excluded by !**/*.png
  • public/access/troubleshooting/chrome-clear-cookies-and-site-data-3.png is excluded by !**/*.png
📒 Files selected for processing (5)
  • pages/_meta.ts (1 hunks)
  • pages/access/_meta.ts (1 hunks)
  • pages/access/login-troubleshooting.mdx (1 hunks)
  • pages/oneleet-agent/faq.mdx (1 hunks)
  • pages/penetration-testing/faq.mdx (1 hunks)
🔇 Additional comments (5)
pages/access/_meta.ts (1)

1-3: Metadata entry looks good

Key matches the new page slug and keeps the casing/style consistent with existing entries. No further action needed.

pages/_meta.ts (1)

3-3: Navigation entry added correctly

The "access": "Access" key slots cleanly into the top-level nav without disrupting existing structure.

pages/oneleet-agent/faq.mdx (1)

12-12: Heading-case tweak is harmless

Capitalisation change preserves the generated slug (frequently-asked-questions), so inbound links remain valid.

pages/penetration-testing/faq.mdx (1)

5-5: Same heading-case tweak here

Slug stability confirmed; no other content affected.

pages/access/login-troubleshooting.mdx (1)

22-27: Referenced screenshots verified – all images are present under public/access/troubleshooting.

Copy link
Member

@jnfrati jnfrati left a comment

Choose a reason for hiding this comment

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

Thanks for setting this up! Leaving one small comment after that happy to approve 👍

jnfrati
jnfrati previously approved these changes Jul 28, 2025
@scherroman
Copy link
Member Author

Bypassing approval requirement here as I just turned off the setting that dismisses approvals when you make new commits. It's quite annoying and we don't do this on our oneleet-platform repo currently for this reason -- it delays getting changes in when you already have an approval/approvals and are just fixing a small thing or a few small things that were mentioned in comments. We have a culture of trust that if a change is significant enough to warrant another review we will ask for approval again

@scherroman scherroman merged commit e296872 into main Jul 28, 2025
4 checks passed
@scherroman scherroman deleted the roman/add-login-troubleshooting-steps branch July 28, 2025 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants