From 571b40b9fbdc5f8e63be8df3b6b49c819d7aedf4 Mon Sep 17 00:00:00 2001 From: monabot Date: Mon, 29 Jan 2024 15:39:46 +0000 Subject: [PATCH] feat(docs): update docs Updates the Wing docs. See details in [workflow run]. [Workflow Run]: https://github.com/winglang/docsite/actions/runs/7698601883 ------ *Automatically created via the "update-docs" workflow* Signed-off-by: monabot --- .../version-latest/01-start-here/05-development.md | 9 +++++++++ .../04-standard-library/cloud/function.md | 3 ++- .../compatibility/compatibility.json | 10 +++++----- versioned_docs/version-latest/06-tools/01-cli.md | 12 ++++++++++++ 4 files changed, 28 insertions(+), 6 deletions(-) diff --git a/contributing_versioned_docs/version-latest/01-start-here/05-development.md b/contributing_versioned_docs/version-latest/01-start-here/05-development.md index cbebff86f..049c66aba 100644 --- a/contributing_versioned_docs/version-latest/01-start-here/05-development.md +++ b/contributing_versioned_docs/version-latest/01-start-here/05-development.md @@ -280,3 +280,12 @@ Lastly you can show linting errors in your IDE by enabling the following setting // in your VS Code settings "rust-analyzer.check.command": "clippy", ``` + +## 🏁 How do I add a quickstart template to the `wing` CLI? + +Adding a new template is straightforward! + +Each template is represented by a folder located at [https://github.com/winglang/wing/tree/main/apps/wing/project-templates], containing all of the files that template should be initialized with. + +Create a new folder with the template name, and insert any code files that are needed to run it. +Unit tests ran with `pnpm turbo test` (or in GitHub Actions once you make a pull request) will automatically validate that the template is valid. diff --git a/versioned_docs/version-latest/04-standard-library/cloud/function.md b/versioned_docs/version-latest/04-standard-library/cloud/function.md index f54cef6b4..9257aa1ad 100644 --- a/versioned_docs/version-latest/04-standard-library/cloud/function.md +++ b/versioned_docs/version-latest/04-standard-library/cloud/function.md @@ -86,7 +86,8 @@ let db = new MyDatabase(); new cloud.Function(inflight () => { log(Json.stringify(db.query("my-key"))); -});``` +}); +``` ## Target-specific details diff --git a/versioned_docs/version-latest/04-standard-library/compatibility/compatibility.json b/versioned_docs/version-latest/04-standard-library/compatibility/compatibility.json index 24584b807..6e1628173 100644 --- a/versioned_docs/version-latest/04-standard-library/compatibility/compatibility.json +++ b/versioned_docs/version-latest/04-standard-library/compatibility/compatibility.json @@ -1063,7 +1063,7 @@ "issue": 624 }, "awscdk": { - "implemented": false + "implemented": true } }, "post": { @@ -1082,7 +1082,7 @@ "issue": 624 }, "awscdk": { - "implemented": false + "implemented": true } }, "put": { @@ -1101,7 +1101,7 @@ "issue": 624 }, "awscdk": { - "implemented": false + "implemented": true } }, "delete": { @@ -1120,7 +1120,7 @@ "issue": 624 }, "awscdk": { - "implemented": false + "implemented": true } }, "patch": { @@ -1139,7 +1139,7 @@ "issue": 624 }, "awscdk": { - "implemented": false + "implemented": true } }, "any": { diff --git a/versioned_docs/version-latest/06-tools/01-cli.md b/versioned_docs/version-latest/06-tools/01-cli.md index 27272ef15..2feb725af 100644 --- a/versioned_docs/version-latest/06-tools/01-cli.md +++ b/versioned_docs/version-latest/06-tools/01-cli.md @@ -23,6 +23,18 @@ Usage: $ wing [command] [options] ``` +## New project: `wing new` + +The `wing new` command can be used to create a new Wing project from a template in your current directory. + +Usage: + +```sh +$ wing new