Skip to content

[Feature]: Add Dedicated Documentation Page for Better User Guidance #237

Description

@MeghPatel-007

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

Users currently need to explore the platform manually to understand available functionality and workflows. There is no centralized in-app location that explains how to use features, navigate the dashboard, understand available tools, or get started efficiently.

This creates friction for first-time users and reduces feature discoverability.

A dedicated Documentation page would provide structured guidance and improve overall usability.

Proposed solution

Introduce a dedicated Documentation section/page inside the application.

Suggested content:

  • Getting Started guide
  • Platform overview
  • Dashboard walkthrough
  • Authentication guide
  • Feature explanations
  • Frequently asked questions
  • Support resources

Suggested implementation:

  • Add /docs route
  • Add Documentation entry in navigation/footer
  • Use reusable documentation components
  • Support responsive layouts
  • Add section navigation for larger content

Alternative solutions considered

Alternative approaches considered:

  • Expanding the FAQ page only → limited for detailed onboarding
  • Adding tooltip-based onboarding → insufficient for complete guidance
  • Improving README only → external documentation is less discoverable for end users

A dedicated in-app Documentation page provides better accessibility and long-term maintainability.

Use case or motivation

This feature would benefit:

  • New users onboarding onto the platform
  • Users exploring available features
  • Users needing workflow guidance
  • Users seeking quick help without leaving the application

Expected improvements:

  • Better onboarding
  • Increased feature adoption
  • Reduced confusion
  • Improved user experience

References or mockups

Suggested structure:

Documentation
├── Getting Started
├── Features Overview
├── Dashboard Guide
├── Authentication
├── FAQs
└── Support

Reference inspiration:

  • Modern documentation portals
  • Product onboarding pages
  • Interactive help centers

Additional context

This enhancement should remain aligned with the existing CodeLens design system.

The page should be fully responsive and should not replace existing README documentation.

Contribution Program:
GSSoC 2026

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions