ic-design-system icon indicating copy to clipboard operation
ic-design-system copied to clipboard

Create Developer Resources section

Open GCHQ-Developer-718 opened this issue 4 months ago • 1 comments

Description

Add a developer resources section. This mostly consists of existing information on the website, mostly from Getting Started. It is a collection of developer-specific information that could be needed at any time (i.e. not just when "getting started").

This could be added as a top level section on the top nav (most intuitive but increases visual clutter), or as a section on the Components page (similar to the current Types page - should be easy for developers to find).

Section contents

Developer resources should have the following subsections:

  1. Testing components
    1. Contains all information from testing section currently in Getting Started
    2. Additionally contains information on accessibility testing. This could be in the form of a quick overview of information in Testing for Accessibility on the main accessibility page, with a link to the full information. Could use a set of links to signpost users to guidance on meeting the Digital Accessibility Policy and Coding for Accessibility.
    3. Add some general guidance about what accessibility testing ICDS do on components, and what accessibility testing we expect our users to do, or raise a separate ticket for this.
  2. Component lifecycle - information currently in Releases and Versions that relates to beta and canary components
  3. Using typescript
    1. Types reference - currently in Components
    2. Link to Typescript section in Getting Started
  4. Versions and migration - information currently in Migrating to V3 and Releases and Versions (except component lifecycle information)
  5. Using icons
    1. Working with Slotted SVGs guidance from Getting start > Development > Install components > React
    2. Link to Styles > Icons from here and link to here from Styles > Icons
    3. Link to icons styles guidance

Acceptance criteria

  • Create Developer Resources section in an appropriate location
  • Add all new information or create tickets for doing this
  • Check no links on site are broken
  • Remove duplicate information (e.g. we don't need the same information in Getting Started and Development resources)

Why do we need it?

It's not necessarily intuitive to go back to "Getting started" to find information on testing, migrating to new versions etc.

Adds some additional information to address specific issues identified during research, e.g. ensuring users understand what accessibility testing they need to do and can easily find information about migrating to new versions and using canary components.

🚨 Urgency (low, medium or high)

Priority 4/5

Related open issues

[Link to other GitHub issues]

GCHQ-Developer-718 avatar Sep 15 '25 09:09 GCHQ-Developer-718

  1. Make this a timeboxed exercise (raise tickets for the things you aren't able to finish)
  2. Create a branch for the overall work, branch off of it when working on child tickets, merge back when it's all done

GCHQ-Developer-299 avatar Oct 02 '25 08:10 GCHQ-Developer-299