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: now the documentation for the pizza-cli can be generated via pizza docs #143

Merged
merged 11 commits into from
Sep 6, 2024

Conversation

nickytonline
Copy link
Member

@nickytonline nickytonline commented Sep 4, 2024

Description

Now the documentation for the pizza-cli can be generated via the docs command, e.g. pizza docs. By default if no path is specified, the default path, "./docs" will be used.

Related Tickets & Documents

Closes #120

Mobile & Desktop Screenshots/Recordings

Steps to QA

  1. Run just build
  2. Run ./build/pizza docs
  3. Notice docs get generated in the ./docs folder.
  4. Run ./build pizza docs ./docs2.
  5. Notice docs get generated in the ./docs2 folder.

Tier (staff will fill in)

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

[optional] What gif best describes this PR or how it makes you feel?

@nickytonline nickytonline force-pushed the nickytonline/docs-command branch 3 times, most recently from f63ca9f to 4a15dee Compare September 4, 2024 23:31
@nickytonline nickytonline requested a review from a team September 4, 2024 23:32
@nickytonline nickytonline force-pushed the nickytonline/docs-command branch from 4a15dee to 74d0ce1 Compare September 4, 2024 23:46
@nickytonline nickytonline marked this pull request as ready for review September 5, 2024 03:02
@nickytonline nickytonline force-pushed the nickytonline/docs-command branch from ffddf29 to e54f774 Compare September 5, 2024 03:04
cmd/docs/docs_test.go Outdated Show resolved Hide resolved
cmd/docs/docs.go Show resolved Hide resolved
@nickytonline nickytonline marked this pull request as draft September 5, 2024 14:24
cmd/docs/docs.go Outdated Show resolved Hide resolved
cmd/root/root.go Outdated Show resolved Hide resolved
cmd/docs/docs.go Show resolved Hide resolved
@nickytonline
Copy link
Member Author

Just need to update tests.

@nickytonline nickytonline force-pushed the nickytonline/docs-command branch 2 times, most recently from 3bd14c5 to da9c252 Compare September 5, 2024 20:14
@nickytonline nickytonline marked this pull request as ready for review September 5, 2024 20:38
.gitignore Outdated Show resolved Hide resolved
cmd/docs/docs.go Outdated Show resolved Hide resolved
@nickytonline nickytonline force-pushed the nickytonline/docs-command branch 4 times, most recently from b40a02a to c77f7de Compare September 6, 2024 12:48
@nickytonline nickytonline force-pushed the nickytonline/docs-command branch from c77f7de to 67f171c Compare September 6, 2024 12:51
@nickytonline nickytonline requested a review from a team September 6, 2024 13:27
@nickytonline nickytonline merged commit 3f5d27e into beta Sep 6, 2024
9 checks passed
open-sauced bot pushed a commit that referenced this pull request Sep 6, 2024
## [1.3.0-beta.8](v1.3.0-beta.7...v1.3.0-beta.8) (2024-09-06)

### 🍕 Features

* now the documentation for the pizza-cli can be generated via pizza docs ([#143](#143)) ([3f5d27e](3f5d27e))
open-sauced bot pushed a commit that referenced this pull request Sep 6, 2024
## [1.3.0](v1.2.1...v1.3.0) (2024-09-06)

### 🍕 Features

* Create a contributor list after generating codeowners ([#141](#141)) ([72c5d58](72c5d58))
* now the documentation for the pizza-cli can be generated via pizza docs ([#143](#143)) ([3f5d27e](3f5d27e))
* Refactors API client into hand rolled sdk in api/ directory ([#111](#111)) ([e16e889](e16e889))
* support fallback attributions when generating codeowners file ([#145](#145)) ([35af4da](35af4da))
* update `CODEOWNERS` copy with command ([#130](#130)) ([a477959](a477959))

### 🐛 Bug Fixes

* Corrects invalid gosec lint error ([#151](#151)) ([f76527f](f76527f))
* Exhume Posthog functionality ([#147](#147)) ([de091ca](de091ca))
* now fallback .sauced.yaml contents get read ([#135](#135)) ([fd658e5](fd658e5))
* NPM cache now looks at package-lock file ([#136](#136)) ([cd4b8da](cd4b8da))
@jpmcb jpmcb deleted the nickytonline/docs-command branch September 6, 2024 16:35
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.

Feature: automate docs generation
3 participants