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 edits to User Guide page #1512

Merged
merged 1 commit into from
Mar 29, 2023
Merged

Docs edits to User Guide page #1512

merged 1 commit into from
Mar 29, 2023

Conversation

Jessy-Morris
Copy link
Contributor

Description

Documentation does not reflect the editorial guidelines outlined in the Project Style Guide. Editing the "User Guide" page to align with the updated Style Guide to improve readability for users.

  • Remove excess '!'
  • Remove metaphorical language
  • Correct heading capitalization
  • Edit context for better readability
  • Add punctuation to lists
  • Correct link text

Related Issue

Fixes #1510

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@Jessy-Morris
Docs edits to User Guide page
95a563c 
Documentation does not reflect the editorial guidelines outlined in the Project Style Guide. Editing the "User Guide" page to align with the updated Style Guide to improve readability for users.
@Jessy-Morris Jessy-Morris added the documentation 📘 Improvements or additions to documentation label Mar 29, 2023
@netlify
Copy link

netlify bot commented Mar 29, 2023 •
edited
Loading

✅ Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit 95a563c
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/64247b6d40db1600086b0e42
😎 Deploy Preview https://deploy-preview-1512--zarf-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Racer159
Racer159 approved these changes Mar 29, 2023
View reviewed changes
Copy link
Contributor

@Racer159 Racer159 left a comment

Choose a reason for hiding this comment

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

lgtm

@Racer159 Racer159 merged commit 385eae7 into main Mar 29, 2023
@Racer159 Racer159 deleted the docs-edits-to-user-guide branch March 29, 2023 19:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Racer159 Racer159 Racer159 approved these changes

@Madeline-UX Madeline-UX Awaiting requested review from Madeline-UX

@JasonvanBrackel JasonvanBrackel Awaiting requested review from JasonvanBrackel

@jeff-mccoy jeff-mccoy Awaiting requested review from jeff-mccoy

@YrrepNoj YrrepNoj Awaiting requested review from YrrepNoj

@wirewc wirewc Awaiting requested review from wirewc

Assignees
No one assigned
Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs edits to "User Guide" page
2 participants
@Jessy-Morris @Racer159