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

Docs edits to "Getting Started" page #1508

Merged
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 "Getting Started" page to align with the updated Style Guide to improve readability for users.

  • Removing excess '!'
  • Adding more context to the Getting Started overview
  • Adding punctuation to list
  • Editing some context to improve readability
  • Correcting heading capitalization
  • Fixing link text at the bottom of the page

Related Issue

Fixes #1498

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

Documentation does not reflect the editorial guidelines outlined in the Project Style Guide. Editing the "Getting Started" 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

Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit c617bec
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/64244fcc035d3f00083e63c6
😎 Deploy Preview https://deploy-preview-1508--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.

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 enabled auto-merge (squash) March 29, 2023 15:22
@Racer159 Racer159 merged commit 904bb2c into main Mar 29, 2023
@Racer159 Racer159 deleted the docs-edits-to-getting-started-page branch March 29, 2023 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs edits to "Getting Started" page
2 participants