Skip to content

Commit

Permalink
feat(docs): update docs (#1035)
Browse files Browse the repository at this point in the history
feat(docs): update docs

Updates the Wing docs. See details in [workflow run].

[Workflow Run]: https://github.com/winglang/docsite/actions/runs/11570850037

------

*Automatically created via the "update-docs" workflow*
  • Loading branch information
monadabot authored Oct 29, 2024
1 parent e50313a commit 2149a0e
Show file tree
Hide file tree
Showing 38 changed files with 38 additions and 0 deletions.
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/01-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Introduction
description: Hands-on introduction to Wing using annotated code
keywords: [Wing language, api]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/01-introduction.md
---


Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/02-hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Hello world
description: Hello world wing example
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/02-hello-world.md
---

# Hello world
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/03-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Primitive values
description: Hello world wing example
keywords: [Wing language, example, primitives, values]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/03-values.md
---

Wing has primitive types including strings, integers, floats, booleans, etc. Here are a few basic examples.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/04-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Variables
description: Using variables with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/04-variables.md
---

Variables are declared with the `let` keyword. The type of most variables can be inferred automatically, but you can also add an explicit type annotation if needed.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/05-for.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: For
description: Using for loops with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/05-for.md
---

Wing supports looping over collections with `for..in` statements.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/06-ifelse.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: If/Else
description: Using if else with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/06-ifelse.md
---

Flow control can be done with if/else statements. The `if` statement is optionally followed by any number of `else if` clauses and a final `else` clause.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/07-while.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: While
description: Using while statements with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/07-while.md
---

While loops repeatedly check a condition and run a block of code until the condition is `false`.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/08-optionality.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Optionality
description: Using while statements with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/08-optionality.md
---

Nullity is a primary source of bugs in software. Being able to guarantee that a value will never be null makes it easier to write safe code without constantly having to take nullity into account.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/09-arrays.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Arrays
description: Using arrays with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/09-arrays.md
---

Arrays are dynamically sized in Wing and are created with the [] syntax.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/10-maps.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Maps
description: Using maps with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/10-maps.md
---

Maps are key-value data structures that let you associate strings with any kinds of other values.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/11-sets.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Sets
description: Using sets with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/11-sets.md
---


Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/12-structs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Structs
description: Using arrays with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/12-structs.md
---

Structs are custom data types you can define to store structured information. They're loosely modeled after typed JSON literals in JavaScript.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/13-bytes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Bytes
description: Hash values in Wing with SHA256
keywords: [Wing language, Hash, SHA256]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/13-bytes.md
---

When working with binary files like images, audio, or other binary formats, you often need to manipulate data at the byte level.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Trailing struct parameters
description: Passing fields directly to a function
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/13-trailing-struct-parameters.md
---

If the last parameter of a function is a struct, then you can pass its fields directly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Async inflight functions
description: Using functions with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/14-async-functions.md
---

Wing supports two function types, [preflight and inflight](/docs/concepts/inflights).
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/14-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Functions
description: Using functions with Wing
keywords: [Wing language, example]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/14-functions.md
---

Wing supports two function types [preflight and inflight](/docs/concepts/inflights).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Variadic Functions
description: Using variadic functions with Wing
keywords: [Wing language, variadic]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/15-variadic-functions.md
---


Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/16-closures.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Closures
description: Closures with Wing
keywords: [Wing language, variadic]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/16-closures.md
---

[Closures](https://en.wikipedia.org/wiki/Closure_(computer_programming)) are functions that captures variables from its surrounding lexical scope, allowing those variables to persist even after the function is executed outside its original context.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/17-recursion.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Recursion
description: Recursion with Wing
keywords: [Wing language, variadic]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/17-recursion.md
---

```js playground example title="main.w"
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/18-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Methods
description: Methods with Wing
keywords: [Wing language, variadic]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/18-methods.md
---

```js playground example title="main.w"
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/19-interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Interfaces
description: Interfaces with Wing
keywords: [Wing language, interfaces]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/19-interfaces.md
---

```js playground example title="main.w"
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/20-sleep.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Sleep
description: Suspends execution for a given duration.
keywords: [Wing language, sleep]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/20-sleep.md
---

`util.sleep` is an [inflight](/docs/concepts/inflights) api.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: String functions
description: Functions for string values in Wing
keywords: [Wing language, string, functions]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/21-string-functions.md
---

Wing provides many useful [string-related functions](/docs/api/standard-library/std/string#string-). Here are some examples to give you a sense of the usage.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/22-regex.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Regular expressions
description: Functions for string values in Wing
keywords: [Wing language, string, functions]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/22-regex.md
---

Wing offers built-in support for regular expressions. Here are some examples of common regexp-related tasks in Wing.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/23-Json.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Json
description: Create Json values in Wing
keywords: [Wing language, json]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/23-Json.md
---

Wing has a dedicated type named `Json` for representing [JSON](https://www.json.org/json-en.html). A `Json` value can be an object, but it can also be an array, string, boolean, number, or null.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/24-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Time
description: Create time/date values in Wing
keywords: [Wing language, time, date]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/24-time.md
---

```js playground example title="main.w"
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/25-random.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Random
description: Create random values in Wing
keywords: [Wing language, random]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/24-random.md
---

Using the [math standard library](/docs/api/standard-library/math/api-reference) you can generate random numbers.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/26-number-parsing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Number Parsing
description: Parse values into numbers
keywords: [Wing language, random]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/26-number-parsing.md
---

```js playground example title="main.w"
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/27-url-parsing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: URL parsing
description: Parse urls in Wing
keywords: [Wing language, URL]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/27-url-parsing.md
---

Parse urls using the http module, works with inflight closures.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/28-sha256.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: SHA256 Hashes
description: Hash values in Wing with SHA256
keywords: [Wing language, Hash, SHA256]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/28-sha256.md
---

```js playground example title="main.w"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Base64 Encoding
description: Encode and decode Base64 values
keywords: [Wing language, Base64]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/29-base64-encoding.md
---

```js playground example title="main.w"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Reading and writing files
description: Reading and writing files with Wing
keywords: [Wing language, Reading files, Writing files]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/30-reading-writing-files.md
---

```js playground example title="main.w"
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/31-directories.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Directories
description: Directories
keywords: [Wing language, Directories]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/31-directories.md
---

Use the `fs` ("filesystem") module to make, read, check, remove directories.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/32-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Testing
description: Directories
keywords: [Wing language, Directories]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/32-testing.md
---

Wing incorporates a [lightweight testing framework](/docs/concepts/tests), which is built around the `wing test` command and the `test` keyword.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/33-http-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: HTTP Client
description: Directories
keywords: [Wing language, HTTP]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/33-http-client.md
---

The Wing standard library comes with [HTTP support](/docs/api/standard-library/http/api-reference).
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/34-http-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: HTTP Server
description: Directories
keywords: [Wing language, HTTP]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/34-http-server.md
---

You can create HTTP servers using the [cloud.Api](/docs/api/standard-library/cloud/api) standard library.
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/35-exec-processes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Exec processes
description: Exec'ing Processes
keywords: [Wing language, HTTP]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/35-exec-processes.md
---

```js playground example title="main.w"
Expand Down
1 change: 1 addition & 0 deletions example_versioned_docs/version-latest/36-reflection.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Type reflection
description: Type reflection
keywords: [Wing language, Type reflection]
image: /img/wing-by-example.png
custom_edit_url: https://github.com/winglang/wing/blob/main/docs/by-example/36-reflection.md
---

The `@type` intrinsic function returns a reflection of the type passed to it.
Expand Down

0 comments on commit 2149a0e

Please sign in to comment.