Skip to content
This repository was archived by the owner on Aug 19, 2025. It is now read-only.
This repository was archived by the owner on Aug 19, 2025. It is now read-only.

Simplify the Getting Started guide and migrate installation options to User Guides #193

@bcipriano

Description

@bcipriano

Describe the documentation issue

I've gotten the impression from some users that the Getting Started guide provides an unnecessary level of flexibility, laying out several options for installing each component which ultimately makes the guide harder to read for novice users.

I think the info on installation methods is valuable, but it may give the user too much choice upfront.

Describe the enhancement

My proposal is:

  • Simplify each guide page to provide one installation option, or if necessary one option per OS.
    • That installation option should be updated to use Python 3 when Python is involved -- we should be encouraging transition to Python 3 wherever possible.
  • Redistribute the other installation methods to User Guide pages per component, for example "Installing Cuebot".

Additional context

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions