Browse Source

Add workspace section to `Anchor.toml` reference (#2105)

Luis Cossío 3 years ago
parent
commit
ebe88187e3
1 changed files with 32 additions and 0 deletions
  1. 32 0
      docs/src/pages/docs/manifest.md

+ 32 - 0
docs/src/pages/docs/manifest.md

@@ -37,6 +37,38 @@ Example:
 url = "https://anchor.projectserum.com"
 ```
 
+## workspace
+
+#### types
+
+Adds a directory where you want the `<idl>.ts` file to be copied when running `anchor build` or `anchor idl parse`. This is helpful when you want to keep this file in version control, like when using it on the frontend, which will probably not have access to the `target` directory generated by anchor.
+
+Example:
+
+```toml
+[workspace]
+types = "app/src/idl/"
+```
+
+#### members
+
+Sets the paths --relative to the `Anchor.toml`--
+   to all programs in the local
+   workspace, i.e., the path to the `Cargo.toml` manifest associated with each
+   program that can be compiled by the `anchor` CLI. For programs using the
+   standard Anchor workflow, this can be ommitted. For programs not written in Anchor
+   but still want to publish, this should be added.
+
+Example:
+
+```toml
+[workspace]
+members = [
+    "programs/*",
+    "other_place/my_program"
+]
+```
+
 ## programs
 
 Example: