Skip to content

[Feature]: Expand FAQ Section with Categorized Questions for Better User Support #180

Description

@ArshiBansal

Before submitting

  • I have searched existing issues and discussions to make sure this idea is not already covered.
  • I have read the contribution guidelines.

Problem statement

The current FAQ section contains only four questions:

What is CodeLens?
What problem does CodeLens solve?
Is my repository data private?
How can I contribute to CodeLens?

While these questions provide a basic introduction, they do not cover many common user concerns related to account setup, platform integrations, analytics, privacy controls, troubleshooting, and support.

As CodeLens aims to help developers track their coding progress across platforms like LeetCode, Codeforces, and GitHub, users may require additional guidance that is currently unavailable in the FAQ section.

Proposed solution

Expand the FAQ section and organize questions into logical categories for improved navigation and discoverability.

  1. Getting Started
    What is CodeLens?
    What problem does CodeLens solve?
    How do I get started with CodeLens?
    Is CodeLens free to use?

  2. Account & Integrations
    Which platforms does CodeLens support?
    How do I connect my coding accounts?
    Can I connect multiple coding profiles at once?
    How do I disconnect a linked account?

  3. Analytics & Progress Tracking
    What statistics does CodeLens track?
    How often is my coding data updated?
    Can I track coding streaks and consistency?
    Can I compare my progress across different platforms?

  4. Privacy & Security
    Is my repository data private?
    Does CodeLens store my passwords?
    Who can view my profile and statistics?
    Can I make my profile private?

  5. Support & Community
    How can I contribute to CodeLens?
    What should I do if my statistics are not updating?
    How can I report a bug or issue?
    How can I request a new feature?

Additionally:

Add accordion-based grouping for categories.
Maintain the existing FAQ design while improving content coverage.
Ensure responsiveness across devices.

Alternative solutions considered

Keep the current 4-question FAQ
Simple but insufficient for growing user needs.
Does not answer many onboarding and platform-related questions.
Move all information to documentation
Useful for detailed guides but less convenient for quick answers.
Requires additional navigation from users.
Direct users to GitHub Issues/Discussions
Can create unnecessary support requests for commonly asked questions.

Use case or motivation

This enhancement would:

Improve onboarding for first-time users.
Reduce repetitive questions and support requests.
Help users understand integrations and analytics features.
Increase transparency regarding privacy and data handling.
Provide a more professional and complete user experience.

A comprehensive FAQ section can act as a self-service support resource and improve overall usability.

References or mockups

No response

Additional context

No response

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions