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.

Sign up for GitHub

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

Jump to bottom

docs: Add back old UX Writing docs into SB8 #3001

Merged
merged 27 commits into from
Jan 13, 2025
Merged

docs: Add back old UX Writing docs into SB8 #3001

merged 27 commits into from
Jan 13, 2025

Conversation

LinKCoding
Copy link
Contributor

@LinKCoding LinKCoding commented Dec 20, 2024 •
edited
Loading

Overview

Add back in UX Writing section to Storybook with some minor updates

PR Checklist

  • Related to designs:
  • Related to JIRA ticket: GM-960
  • I have run this code to verify it works

Testing Instructions

  1. Go to the preview link and scroll down to the "UX Writing" section.
  2. Navigate through the pages to see that they load correctly
  3. (Optionally) click on links to check they work and link to their appropriate page
  4. (Optionally) proofread along the way
  5. ...
  6. Profit!

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Dec 20, 2024 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 6601b1b.

☁️ Nx Cloud last updated this comment at 2025-01-10 21:31:41 UTC

@LinKCoding LinKCoding changed the title docs(UX Writing) (docs)UX Writing Dec 20, 2024
LinKCoding
LinKCoding commented Dec 20, 2024
View reviewed changes
packages/styleguide/src/lib/UX Writing/Accessibility guidelines.mdx Outdated


### Imagery
- Do all non-decorative images or icons contain[alt text](https://skillsoftdev.atlassian.net/wiki/spaces/265f8fcabee0479ea6841c6b0b7e2171/pages/4440883349/Alternate+alt+text)?
Copy link
Contributor Author

@LinKCoding LinKCoding Dec 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

certain pages pointed to notion, like this one, but I found the corresponding confluence page.
since this repo is open-source, should we make this information more available?
e.g. I can copy/paste what's in the confluence onto this page.

Copy link
Contributor

Choose a reason for hiding this comment

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

Let me take a look at our Accessibility guidelines page and come back to this. We may be able to link to a section there instead.

Copy link
Contributor

Choose a reason for hiding this comment

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

Circling back...
Yes this section looks perfect! https://skillsoftdev.atlassian.net/wiki/spaces/265f8fcabee0479ea6841c6b0b7e2171/pages/4440883349/Alternate+alt+text
Let's add it under "Component guidelines" for now (even though it's not technically a component).
Thanks so much for finding it!

@LinKCoding LinKCoding changed the title (docs)UX Writing (docs)UX Writing: Add back old docs into SB8 Dec 20, 2024
@LinKCoding LinKCoding changed the title (docs)UX Writing: Add back old docs into SB8 (docs): Add back old UX Writing docs into SB8 Dec 20, 2024
@LinKCoding LinKCoding changed the title (docs): Add back old UX Writing docs into SB8 docs: Add back old UX Writing docs into SB8 Dec 20, 2024
@uxemilylee
Copy link
Contributor

This is great, Kenny! Thank you!
Here are a few more minor edits I'd like to make:

  1. [For the title of the page:]
    UI copy checklist => DIY UX writing in 8 steps

  2. For best practices for writing for specific components, like alerts, errors, or confirmation dialogs, check out our Component Guidelines. => For best practices in writing for specific components, such as alerts, errors, or confirmation dialogs, check out our [component guidelines].

  3. Could we add periods to the bulleted items like how I just updated on this page? https://skillsoftdev.atlassian.net/wiki/spaces/UXW/pages/4556489307/DIY+UX+writing+in+8+steps

@uxemilylee
Copy link
Contributor

Sorry one last thing... This is how I had updated the "Accessible writing checklist" page: https://skillsoftdev.atlassian.net/wiki/spaces/UXW/pages/4556161643/Accessible+writing+checklist

@LinKCoding LinKCoding marked this pull request as ready for review January 3, 2025 20:16
@LinKCoding LinKCoding requested a review from a team as a code owner January 3, 2025 20:16
@LinKCoding LinKCoding requested a review from uxemilylee January 3, 2025 21:29
@LinKCoding LinKCoding requested a review from aresnik11 January 10, 2025 21:27
@codecademydev
Copy link
Collaborator

📬Published Alpha Packages:

@codecademy/[email protected]

@codecademydev
Copy link
Collaborator

🚀 Styleguide deploy preview ready!

https://678191d31cff3d68ed06c0d5--gamut-preview.netlify.app

Deploy Logs

@LinKCoding LinKCoding added the Ship It :shipit: Automerge this PR when possible label Jan 13, 2025
@codecademydev codecademydev merged commit aecfe27 into main Jan 13, 2025
16 of 17 checks passed
@codecademydev codecademydev removed the Ship It :shipit: Automerge this PR when possible label Jan 13, 2025
@codecademydev codecademydev deleted the kl-gm-960 branch January 13, 2025 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aresnik11 aresnik11 aresnik11 approved these changes

@BandanaKM BandanaKM Awaiting requested review from BandanaKM BandanaKM is a code owner automatically assigned from Codecademy/gamut

@dreamwasp dreamwasp Awaiting requested review from dreamwasp dreamwasp is a code owner automatically assigned from Codecademy/gamut

@uxemilylee uxemilylee Awaiting requested review from uxemilylee

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@LinKCoding @uxemilylee @codecademydev @aresnik11