Docs edits to "Understanding Zarf Packages" page #1545
Assignees
Labels
documentation 📘
Improvements or additions to documentation
Comments
5 tasks
Racer159
added a commit
that referenced
this issue
Apr 7, 2023
## Description Documentation does not reflect the editorial guidelines outlined in the Project Style Guide. Editing the "Understanding Zarf Packages" page to align with the updated Style Guide to improve readability for users. - Consolidate information to improve readability - Fix "air-gapped" grammar - Capitalize K8s/K3s - Remove "info" admonition and create list - Introduce more straightforward technical/professional language - Ensure note formatting is consistent with the style guide - Edit headings to maintain consistency ## Related Issue Fixes #1545 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [X] Other (security config, docs update, etc) ## Checklist before merging - [X] Test, docs, adr added or updated as needed - [X] [Contributor Guide Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow) followed --------- Co-authored-by: Wayne Starr <[email protected]>
github-project-automation
bot
moved this from New Requests
to Done
in Zarf Project Board
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
Documentation does not reflect the editorial guidelines outlined in the Project Style Guide. Editing the "Understanding Zarf Packages" page to align with the updated Style Guide to improve readability for users.
The text was updated successfully, but these errors were encountered: