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

feat: Update README docs #186

Merged
merged 1 commit into from
Sep 13, 2024
Merged

feat: Update README docs #186

merged 1 commit into from
Sep 13, 2024

Conversation

jpmcb
Copy link
Member

@jpmcb jpmcb commented Sep 12, 2024

Description

  • Some updates to copy (including some command fixes that were broken)
  • Moved the docker stuff into its own section
  • Added a section for the pizza action
  • Added explicit "Docs" section
  • Elaborated some things in the "Usage" section and moved Bekah's 1.4.0 "pizza generate config" section closer to the "pizza generate codeowners" section
  • Added "pizza insights" section
  • Added some further context to the "Configuration Schema" section

Give it a look here since the GitHub diff is kinda gross:

https://github.com/open-sauced/pizza-cli/blob/update-readme/README.md

Related Tickets & Documents

Followup to: #178

Closes: #183

Tier (staff will fill in)

  • Tier 1
  • Tier 2
  • Tier 3
  • Tier 4

@jpmcb jpmcb force-pushed the update-readme branch 6 times, most recently from 968e45c to 06b3cf5 Compare September 12, 2024 22:56
@jpmcb jpmcb requested review from a team and BekahHW September 12, 2024 22:59
@jpmcb jpmcb marked this pull request as ready for review September 12, 2024 23:00
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Member

@BekahHW BekahHW left a comment

Choose a reason for hiding this comment

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

A couple of minor comments. Feel free to merge as is or to make the updates if you see fit.

Copy link
Member

@nickytonline nickytonline left a comment

Choose a reason for hiding this comment

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

🚢

Signed-off-by: John McBride <[email protected]>
@jpmcb jpmcb merged commit 99328aa into beta Sep 13, 2024
9 checks passed
@jpmcb jpmcb deleted the update-readme branch September 13, 2024 17:02
open-sauced bot pushed a commit that referenced this pull request Sep 13, 2024
## [1.5.0-beta.2](v1.5.0-beta.1...v1.5.0-beta.2) (2024-09-13)

### 🍕 Features

* Update README docs ([#186](#186)) ([99328aa](99328aa))
open-sauced bot pushed a commit that referenced this pull request Sep 16, 2024
## [1.5.0](v1.4.0...v1.5.0) (2024-09-16)

### 🐛 Bug Fixes

* Config path prefers local dir vs. home dir ([#184](#184)) ([859446a](859446a))
* Don't overwrite ldflags in justfile builds ([#171](#171)) ([e024687](e024687))

### 🍕 Features

* Cut 2.0.0 release ([#193](#193)) ([278a833](278a833))
* pizza generate insight command ([#179](#179)) ([7315a1d](7315a1d))
* Update README docs ([#186](#186)) ([99328aa](99328aa))
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.

Chore: update the OpenSauced logo in the README
3 participants