Skip to content

Improve onboarding UX, navigation structure, and add beginner-friendly examples #12032

@sarika-03

Description

@sarika-03

Issue Category

Suggestion for existing article

Affected Documentation Page URL

https://docs.continue.dev/

Issue Description

The current documentation is informative but lacks a clear onboarding flow and structured navigation, which can make it difficult for new users to get started.

Key Issues

  1. No clear "Start Here" onboarding

    • The landing page directly explains concepts like checks without guiding beginners.
    • New users may not understand where to begin.
  2. Navigation structure is unclear

    • Sections like Getting Started, Guides, and Reference are mixed without a clear learning flow.
    • No separation between beginner and advanced content.
  3. Lack of practical examples

    • Examples exist but lack:
      • Input/output clarity
      • Real-world use cases
      • Expected results
  4. Concept explanation is too abstract

    • For example, "checks are markdown files" is technically correct but not beginner-friendly.
  5. UI/UX readability issues

    • Long text blocks without callouts or visual hierarchy
    • No diagrams or flow visuals to explain how Continue works

Why this matters

Better onboarding and structure would:

  • Reduce confusion for new users
  • Improve adoption
  • Make the docs more accessible to non-experts

Expected Content

Suggested Improvements

1. Add a "Start Here" section

A guided onboarding flow:

  • Install Continue
  • Run your first check
  • Understand results

2. Improve navigation structure

Example:

Getting Started

  • Introduction
  • Quickstart
  • Installation

Core Concepts

  • Checks
  • Rules
  • Configs

Guides

  • GitHub Integration
  • CI/CD

Reference

  • CLI
  • Config API

3. Add structured examples

Each example should include:

  • Input (PR/code)
  • Output (pass/fail)
  • Explanation

4. Improve conceptual explanations

Explain concepts using analogies:

  • "Checks are like automated reviewers"

5. Add UI improvements

  • Callouts (info/warning)
  • Diagrams (PR → Check → Result flow)
  • Shorter paragraphs for readability

6. Add FAQ section

Common beginner questions:

  • How checks run
  • What happens on failure
  • Data/privacy concerns

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsRelates to documentationarea:onboardingkind:enhancementIndicates a new feature request, imrovement, or extension

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions