Summarisation button - Githubissues

centrica-engineering / nucleus-docs

Documentation for the Nucleus Design System

https://nucleus.design

2 stars 10 forks source link

Summarisation button #602

Closed jholt1 closed 5 months ago

jholt1 commented 5 months ago

Outcome

To get a summary of the documentation for that component.

Scope

[x] API for summarisation.
[x] Summarisation button at the top of the page.

Worries

It is AI generated and we don't know what it might say.
Might mean they don't read the whole documentation.

Benefits

Forces us to structure the page correctly, in a readable manner.
If an AI can summarise it well, then most people should be able to understand the documentation.
Might mean that people find the right component quicker.

RobTobias123 commented 5 months ago

I really like this idea, minor suggestions for visual improvement: Make icon similar in colour to the others. On the label, just 'Summarise' (or 'AI summary' ?)- without the 'it' and exclamation. Can we make the results use UK English spelling instead?

RobTobias123 commented 5 months ago

I looked for a material version of the icon you used Jon, but there isn't one - so I tried a couple of others but I think the 3 x sparkles work best so have created one to match the others used (see Rob's suggestion). Thoughts? Will add the SVG file here...

RobTobias123 commented 5 months ago

(Couldn't remember if it needed to be coloured or black for docs - here's both: icon-ai-sparkle-teal.svg.zip icon-ai-sparkle.svg.zip