Spec list

[andij]

Outcome

Display the specification tables into description lists instead.

Scope

• Replace the <table> markup in specification.astro with <dl>
• Integrate the properties into the same list as attributes
• Decide on the most sensible content structure
• Implement the additional tables (Slots, Events)

[andij]

Here are two PRs to help facilitate the user testing. Neither of these PRs should be merged. Once the tests have been performed these PRs are to be closed.

• Feature/spec list #325
• feat: spec table #338

[RobTobias123]

Here's the suggested fonts and styles applied to the same spec list - with 48px paragraph spacing and keylines. Just a suggestion using existing styles. https://www.figma.com/file/wyuLUEt3qm01mR8E6Wm2Pf/Nucleus-Docs-exploration---engaging-and-interactive?type=design&node-id=279%3A5416&mode=design&t=T367BSaTQr4S3o4j-1

[andij]

Here's the updated URLs for user testing:

Spec table:
https://feature-spec-table.nucleus-docs.pages.dev/components/ns-landmark/

Spec list:
https://feature-spec-list.nucleus-docs.pages.dev/components/ns-landmark/

[RobTobias123]

Here's the results analysis of significant findings and recommendations from the user testing:

#328 (comment)

[RobTobias123]

Summary based on the results of the user testing for specs...

• DL format worked best for High-volume data by a significant amount.

• Table format worked best for Low-volume data - though the difference was less.

The recommendation is to proceed with using both styles as above.

(However, it should be considered if it may be of benefit to utilise the same format for both if it reduces complexity/maintenance effort etc. If that is the case I would suggest using DL for both.)

[andij]

• PR for the Specification list/table: Feature/specification #375

To check, take a look at these preview pages:

• https://feature-specification.nucleus-docs.pages.dev/components/ns-accordion/#specification (both low volume)
• https://feature-specification.nucleus-docs.pages.dev/components/ns-card/#specification (both medium volume)
• https://feature-specification.nucleus-docs.pages.dev/components/ns-inputter/#specification (high volume for attributes also includes Events table)