feat(cli): wing gen-docs
#7056
Merged
feat(cli): wing gen-docs
#7056
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for opening this pull request! 🎉
|
|
Console preview environment is available at https://wing-console-pr-7056.fly.dev 🚀 Last Updated (UTC) 2024-08-30 04:04 |
Signed-off-by: monada-bot[bot] <[email protected]>
monadabot
added
the
⚠️ pr/review-mutation
Chriscbr
removed
the
⚠️ pr/review-mutation
Chriscbr
commented
Aug 30, 2024
Signed-off-by: monada-bot[bot] <[email protected]>
Signed-off-by: monada-bot[bot] <[email protected]>
Signed-off-by: monada-bot[bot] <[email protected]>
monadabot
added
the
⚠️ pr/review-mutation
Chriscbr
removed
the
⚠️ pr/review-mutation
Signed-off-by: monada-bot[bot] <[email protected]>
monadabot
added
the
⚠️ pr/review-mutation
BenchmarksComparison to Baseline ⬜🟥⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜
⬜ Within 1.5 standard deviations Benchmarks may vary outside of normal expectations, especially when running in GitHub Actions CI. Results
Last Updated (UTC) 2024-08-30 04:09 |
Chriscbr
removed
the
⚠️ pr/review-mutation
|
Congrats! 🚀 This was released in Wing 0.83.8. |
eladb
reviewed
Sep 1, 2024
apps/wing/src/cli.ts
Outdated
| @@ -164,6 +164,12 @@ async function main() { | |||
| .hook("preAction", collectAnalyticsHook) | |||
| .action(runSubCommand("lsp")); | |||
|
|
|||
| program | |||
| .command("generate-docs") | |||
There was a problem hiding this comment.
Suggested change
| .command("generate-docs") | |
| .command("docs") |
I think wing docs is enough unless you are reserving it for something in the future?
There was a problem hiding this comment.
We already have a wing docs command which opens your browser to winglang.io/docs 🤷
There was a problem hiding this comment.
Oh, I see...
Is it useful? Maybe we can deprecate it and reuse it for doc generation, no?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new
gen-docssubcommand that generates API documentation for your Wing library. Runningwing gen-docswill generate an API.md file in your current directory.Closes #6905
Checklist
pr/e2e-fulllabel if this feature requires end-to-end testingBy submitting this pull request, I confirm that my contribution is made under the terms of the Wing Cloud Contribution License.