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

audit updates to Content-principles and links added #1819

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

adrian-yee
Copy link
Contributor

@adrian-yee adrian-yee commented Oct 3, 2024

Provide an overview of your changes here. Include screenshots, photos or links if necessary.

View preview

Checklist

Preflight

  • Prefix the PR title with the slug of the package or component - e.g. accordion: Updated padding or docs: Updated header links
  • Describe the changes clearly in the PR description
  • Read and check your code before tagging someone for review
  • Create a changeset file by running yarn changeset. Learn more about change management.

Testing

  • Manually test component in various modern browsers at various sizes (use Browserstack)
  • Manually test component in various devices (phone, tablet, desktop)
  • Manually test component using a keyboard
  • Manually test component using a screen reader
  • Manually tested in dark mode
  • Component meets Web Content Accessibility Guidelines (WCAG) 2.1 standards
  • Add any necessary unit tests (HTML validation, snapshots etc)
  • Run yarn test to ensure tests are passing. If required, run yarn test -u to update any generated snapshots.

Documentation

  • Create or update documentation on the website
  • Create or update stories for Storybook
  • Create or update stories for Playroom snippets

Creating new component

  • Document the component for the website (docs/overview.mdx and docs/code.mdx at a minimum)
  • Preconstruct entrypoint has been created (run yarn in the root of the repo to do this)
  • Changeset file includes a minor
  • Export components for docs site and Playroom (docs/components/designSystemComponents.tsx)
  • Add component to Kitchen Sink (.storybook/stories/KitchenSink.tsx)
  • Add snippets to Playroom (docs/playroom/snippets.ts)
  • Add pictogram to Docs (docs/components/pictograms/index.tsx)

@adrian-yee adrian-yee self-assigned this Oct 3, 2024
Copy link

changeset-bot bot commented Oct 3, 2024

🦋 Changeset detected

Latest commit: e7e0529

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@ag.ds-next/docs Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Oct 3, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://agriculturegovau.github.io/agds-next/pr-preview/pr-1819/
on branch gh-pages at 2024-10-03 02:31 UTC

Copy link

sonarcloud bot commented Oct 3, 2024


If content already appears on the Export Service or the [Department of Agriculture, Fisheries and Forestry](https://www.agriculture.gov.au/) (DAFF) website, link to the authoritative source.
If content already appears somewhere online link to the authoritative source. For example, the [Export Service](https://exports.agriculture.gov.au/). Or the [Department of Agriculture, Fisheries and Forestry](https://www.agriculture.gov.au/) (DAFF) website.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feels weird starting this sentence with "or", shouldn't it just be a continuation? For example, the Export Service of the DAFF website

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Suzanne-aff As discussed

@@ -7,7 +7,7 @@ order: 1

You can use these standards to guide you to create content that is clear and effective.

Good content reduces the cognitive load on users and helps them achieve their aims more easily.
Good content reduces the cognitive load on users. It helps them achieve their aims more easily.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weirdly, having a new sentence for "It" seems to increase cognitive load for me 😅

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Suzanne-aff As discussed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants