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.

Sign up for GitHub

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(docs): update docs #770

Merged
merged 1 commit into from
Jan 30, 2024
Merged

feat(docs): update docs #770

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions contributing_versioned_docs/version-latest/01-start-here/05-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
3 changes: 2 additions & 1 deletion versioned_docs/version-latest/04-standard-library/cloud/function.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ let db = new MyDatabase();

new cloud.Function(inflight () => {
log(Json.stringify(db.query("my-key")));
});```
});
```

## Target-specific details

Expand Down
10 changes: 5 additions & 5 deletions versioned_docs/version-latest/04-standard-library/compatibility/compatibility.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@
"issue": 624
},
"awscdk": {
"implemented": false
"implemented": true
}
},
"post": {
Expand All @@ -1082,7 +1082,7 @@
"issue": 624
},
"awscdk": {
"implemented": false
"implemented": true
}
},
"put": {
Expand All @@ -1101,7 +1101,7 @@
"issue": 624
},
"awscdk": {
"implemented": false
"implemented": true
}
},
"delete": {
Expand All @@ -1120,7 +1120,7 @@
"issue": 624
},
"awscdk": {
"implemented": false
"implemented": true
}
},
"patch": {
Expand All @@ -1139,7 +1139,7 @@
"issue": 624
},
"awscdk": {
"implemented": false
"implemented": true
}
},
"any": {
Expand Down
12 changes: 12 additions & 0 deletions versioned_docs/version-latest/06-tools/01-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <template>
```

Run `wing new` without any arguments to view the available templates.

## Run: `wing run|it`

You can use the `run` command (or `it`) when you want to interact with your Wing program in the
Expand Down
Loading