Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Content guidance - discovery for the best solution #372

Open
2 of 5 tasks
Tracked by #473
RobTobias123 opened this issue Feb 7, 2024 · 2 comments
Open
2 of 5 tasks
Tracked by #473

Content guidance - discovery for the best solution #372

RobTobias123 opened this issue Feb 7, 2024 · 2 comments
Labels
Area: Discovery Getting an understanding to do a piece of work Status: On Hold Awaiting for clarification or another issue to be resolved Type: Documentation Improvements or additions to documentation

Comments

@RobTobias123
Copy link
Contributor

RobTobias123 commented Feb 7, 2024

Outcome

To understand the best approach to creating an interactive Content Guidance section for the docs components pages. This should include a solution that can be included in time for the initial launch.

Scope

  • Take a look at the concepts shaped so far in Figma exploratory work
  • Further refine the design for an MVP for the initial launch end of Feb. This is likely to be the simplest, quickest way to achieve a more helpful interaction than currently available.
  • Consider how other options could work
  • Assess the pros and cons of each and decide on a direction as a team.
  • Apply once all content is populated.
@RobTobias123 RobTobias123 self-assigned this Feb 7, 2024
@RobTobias123 RobTobias123 added the Type: Documentation Improvements or additions to documentation label Feb 7, 2024
@RobTobias123 RobTobias123 added this to the Internal tools milestone Feb 7, 2024
@RobTobias123
Copy link
Contributor Author

Idea for the initial launch version is...

  • Use existing content guidance 'pink labelled' images. (Only updating where this is necessary due to component updates)
  • Find out the deepest letter used across all.
  • Create a set of SVGs that reflect the pink label style and upload assets to a suitable location.
  • Replace the Key letter in 1st column of the explanatory table with the appropriate SVG asset and wrap the Section anchor link around it so that when clicked it will navigate on the page to the labelled image for reference.

@RobTobias123 RobTobias123 added the Status: On Hold Awaiting for clarification or another issue to be resolved label Feb 27, 2024
@RobTobias123
Copy link
Contributor Author

The basic version using style coordinated key letters implemented for initial release. The more interactive versions discovered will be refined and applied in subsequent iterations of docs.

@RobTobias123 RobTobias123 removed their assignment Feb 27, 2024
@andij andij added the Area: Discovery Getting an understanding to do a piece of work label Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Discovery Getting an understanding to do a piece of work Status: On Hold Awaiting for clarification or another issue to be resolved Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants