Skip to content

Commit

Permalink
removed build manifest from tutorial wraps
Browse files Browse the repository at this point in the history
  • Loading branch information
krisbitney committed Oct 31, 2023
1 parent 44d50d2 commit d685bad
Show file tree
Hide file tree
Showing 7 changed files with 1 addition and 29 deletions.

This file was deleted.

4 changes: 0 additions & 4 deletions snippets/create-wraps-tutorial/rust/polywrap.build.yaml

This file was deleted.

3 changes: 0 additions & 3 deletions snippets/create-wraps-tutorial/typescript/polywrap.build.yaml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ source:
module: ./src/index.ts
schema: ./polywrap.graphql
extensions:
build: ./polywrap.build.yaml
docs: ./polywrap.docs.yaml
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,12 +146,7 @@ For example, the `import_abis` feature can be used in a monorepo that contains o

There are two types of manifest extensions you can register in the project manifest: `build` and `docs`. The `polywrap.build.yaml` build manifest enables developers to customize the wrap build process. The `polywrap.docs.yaml` manifest allows you to provide metadata for package registries and include common documentation files such as a `README.md`.

```yaml
extensions:
build: ./polywrap.build.yaml
```

We will use the `docs` manifest extensions later on to include a `README.md` file in our package. We won't be using the `build` extension in Part One of this tutorial, but we'll dive into it in Part Two. If you'd like, you can remove the `build` extension property and delete the `polywrap.build.yaml` file.
We will use the `docs` manifest extensions later on to include a `README.md` file in our package. We won't be using the `build` extension in Part One of this tutorial, but we'll dive into it in Part Two.

### **Resources**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ Let's take a look at the contents of the project we just created. Then, in the n
```
project/
├── polywrap.yaml # Project manifest File
├── polywrap.build.yaml # Build manifest File
├── polywrap.graphql # Wrap Schema
├── src/
│ └── lib.rs # Entry point; exports module defined in schema
Expand All @@ -85,7 +84,6 @@ project/
```
project/
├── polywrap.yaml # Project manifest File
├── polywrap.build.yaml # Build manifest File
├── polywrap.graphql # Wrap Schema
├── module/
│ ├── module.go # Entry point; exports module defined in schema
Expand All @@ -108,7 +106,6 @@ project/
```
project/
├── polywrap.yaml # Project manifest File
├── polywrap.build.yaml # Build manifest File
├── polywrap.graphql # Wrap Schema
├── src/
│ ├── index.ts # Entry point; exports module defined in schema
Expand All @@ -134,7 +131,6 @@ project/
```
project/
├── polywrap.yaml # Project manifest File
├── polywrap.build.yaml # Build manifest File
├── polywrap.graphql # Wrap Schema
├── src/
│ ├── index.ts # Entry point; exports module defined in schema
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
### **`polywrap.yaml`**
The `polywrap.yaml` project manifest is a high-level configuration file describing a Polywrap project.

### **`polywrap.build.yaml`**
The `polywrap.build.yaml` build manifest enables build process customization. We won't need to modify this file, but we will learn how to do so anyway in Part Two of the tutorial. The file is not needed in most projects and can in fact be deleted.

### **`polywrap.graphql`**
Each wrap project has a [Wrap Schema](/concepts/wrap-schema). The schema defines the wrap's interface, including dependencies, methods, and custom types. Polywrap uses the schema to generate the wrap's serialization bindings and validate the wrap's implementation. The schema is compiled to a `wrap.info` ABI file at build time and stored in the wrap package. In this tutorial, we'll learn how to write a Wrap Schema. It's easy!

Expand Down

0 comments on commit d685bad

Please sign in to comment.