Skip to content

Create troubleshooting documentation for installing the prototype kit #45

@jrbarnes9

Description

@jrbarnes9

Background

The Design System currently has a guidance page for the ONS Prototype Kit. However, there is no guidance for troubleshooting common issues in installation and setup. For example, how to resolve build errors, console errors, conflicts and account issues. There is information available about how to contact the team if further support is needed.

We did receive feedback in a recent survey regarding this:

The prototype kit is great to use but the initial set up was painful and needed support to do so as the guidance on the Design System was not accurate

Tasks

  1. Identify the main pain points experienced by users when setting up the prototype kit
  2. Document guidance for solving the main issues experienced
  3. Possible requirement for content design to review
  4. Publish the additional guidance to the "Installing the prototype kit" section

Acceptance Criteria

We have identified the main issues users experience when installing the prototype kit and have guidance available on the ONS Prototype Kit page to resolve the most common issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationDocumentation content or feature for the prototype kitNeeds validatingFor investigation by DS teamOn holdPause working on this

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions