Content - review all pages

[RobTobias123]

Outcome

All page content assessed and long form content pages corrected for textual inaccuracies, spelling mistakes, missing sections, missing or inconsistent headings, missing punctuation, broken links, etc. (Any major decision points and directions taken, highlighted and noted here).

Scope

• home page - PR Content/home updates #520
• Introduction page - Content/intro corrections #517
• Guidelines
  Update devices.mdx #515 Update vanilla-first.mdx #514 Content/contributing corrections #513 Content/our process corrections #510 Content/working with nucleus corrections #509 Content/tokens corrections #508 Content - placeholder images #506 Content/assets corrections 2 #504 Content/lists corrections #500 Update typography.mdx #499 Update accessibility.mdx #497 Content/guidelines corrections #495
• Components (execution of updates to this is scoped in [Epic] Content - update content from review #521 )

This would be the minimum required before launch. Following on from that the intention is to use suitable predefined criteria or AI prompts in a tool such as Grammarly or Co-pilot to create a consistent tone of voice, improve grammar, clarity, correctness, and how engaging the content may be to the intended audience. (Briefly explored 7 March by Drew, Mekala, Rob).

Preset criteria using Grammarly to help assess content:

Audience:
Knowledgable. Requires focus to read and understand.

Formality:
Neutral. Restricts slang but allows standard casual expressions.

Domain:
General. (only option of free account)

Intent:
Inform.

Address correctness (spelling, articulation grammar etc.) and clarity alerts.
Manually find and replace any slanted quote marks or apostrophes and replace with straight variants.
Use double quotes (straight) only where a quote is verbatim, otherwise use single quotes.

[RobTobias123]

I'm making a start on the Guidelines section.

[RobTobias123]

Guidelines/Principles assessed and corrected.

PR for review please: #495

[RobTobias123]

Guidelines/Accessibility page assessed and corrected. Plus commented out a link to a Web Accessibility Toolbar tool that no longer appears to be available at https://developer.paciellogroup.com/resources/wat/

PR for review please: https://github.com/centrica-engineering/nucleus-docs/pull/497

[RobTobias123]

Guidelines/Principles suggestions applied and updated usage of quote mark types as agreed:

PR for review please: #495

[RobTobias123]

Updated Guidelines/Accessibility to new branch independent of principles branch. Update link in post above to #497 and deleted #496.

[RobTobias123]

Updated Guidelines/Typography page.

Corrected spelling and grammar. Applied a 'purpose' div style to leading sentence to retain consistency with other pages. Changed 'Related links' from H3 to H2 as it applies to all, not just the Semantics vs. Styles section.

PR for review please: #499

[RobTobias123]

Updated Guidelines/Lists page.

Corrected spelling, grammar and punctuation and improved consistency (eg. list/lists etc.)

PR for review please: #500

[RobTobias123]

All PRs above have been updated to use 'third-person' and present tense where applicable, as requested and due to common trends observed. This method will be additionally and consistently applied to all pages to be reviewed in this ticket.

[RobTobias123]

Updated Guidelines/Assets page.

PR for review please: #504

I've added a question on the display of ratios within body text that requires a decision.

[RobTobias123]

Updated Guidelines/Tokens

Updated grammar and made in the third person. Typography paragraph consistent with Typography page wording.

PR for review please: #508

[RobTobias123]

Merged the approved PR #495 Principles page.

[RobTobias123]

PR #499 Typography page was approved and merged

[RobTobias123]

PR #500 Lists page was approved and merged

[RobTobias123]

Updated Guidelines/Working with Nucleus

Updated grammar, punctuation, corrected spellings, improved clarity etc. Consistently applied a lead paragraph style to para steps 1-3, re-written in the 3rd party.

PR for review please: #509

[RobTobias123]

Updated Guidelines/Process

Rewritten in third person, corrected grammar and punctuation etc.

PR for review please: #510

[RobTobias123]

Approved and Merged #497

[RobTobias123]

Approved and merged #509

[RobTobias123]

Updated #504 Assets - Aspect ratios info following comments. Please review/approve.

[RobTobias123]

Approved and merged #510

[RobTobias123]

Assets #504 approved and merged.

[RobTobias123]

Updated remaining Guidlines pages for contributing, vanilla first and devices.

PRs for review please:

Contributing #513
Vanilla first #514
Devices #515

[RobTobias123]

Introduction page with updated grammar, punctuation and spelling and rewrote in the third person.

PR for review please: #517

[RobTobias123]

Updated #513 based on suggestions. Please check you're happy with the changes.

[RobTobias123]

Approved and merged #514

[RobTobias123]

Updated #515 based on suggestion. Please check you're happy with the changes.

[RobTobias123]

Approved and merged #517

[RobTobias123]

Home page content considered and adjusted. PR for review please:
#520

[RobTobias123]

#513 contributions approved and merged.

[RobTobias123]

Approved and merged #515 (devices).

[RobTobias123]

do donts of Patterns/ Telephone Numbers was updated. PR for review: #595