restre manifests

examples/fuel-explorer/fuel-explorer/fuel_explorer.manifest.yaml

@@ -1,13 +1,39 @@
----
+# A namespace is a logical grouping of declared names. Think of the namespace
+# as an organization identifier
 namespace: fuellabs
+
+# The identifier field is used to identify the given index.
 identifier: explorer
+
+# The abi option is used to provide a link to the Sway JSON ABI that is generated when you
+# build your project.
 abi: ~
+
+# The particular start block after which you'd like your indexer to start indexing events.
+start_block: ~
+
+# The particular end block after which you'd like your indexer to stop indexing events.
+end_block: ~
+
+# The `fuel_client` denotes the address (host, port combination) of the running Fuel client
+# that you would like your indexer to index events from. In order to use this per-indexer
+# `fuel_client` option, the indexer service at which your indexer is deployed will have to run
+# with the `--indexer_net_config` option.
 fuel_client: ~
-graphql_schema: examples/fuel-explorer/fuel-explorer/schema/fuel_explorer.schema.graphql
+
+# The contract_id specifies which particular contract you would like your index to subscribe to.
+contract_id: ~
+
+# The graphql_schema field contains the file path that points to the GraphQL schema for the
+# given index.
+graphql_schema:  examples/fuel-explorer/fuel-explorer/schema/fuel_explorer.schema.graphql
+
+# The module field contains a file path that points to code that will be run as an executor inside
+# of the indexer.
+# Important: At this time, wasm is the preferred method of execution.
 module:
   wasm: target/wasm32-unknown-unknown/release/fuel_explorer.wasm
-metrics: ~
-contract_id: ~
-start_block: 2376387
-end_block: 2376887
+
+# The resumable field contains a boolean that specifies whether or not the indexer should, synchronise
+# with the latest block if it has fallen out of sync.
 resumable: true

examples/hello-world/hello-world/hello_world.manifest.yaml

@@ -1,13 +1,39 @@
----
+# A namespace is a logical grouping of declared names. Think of the namespace
+# as an organization identifier
 namespace: fuellabs
-identifier: hello_world_2
+
+# The identifier field is used to identify the given index.
+identifier: hello_world
+
+# The abi option is used to provide a link to the Sway JSON ABI that is generated when you
+# build your project.
 abi: ~
+
+# The particular start block after which you'd like your indexer to start indexing events.
+start_block: ~
+
+# The particular end block after which you'd like your indexer to stop indexing events.
+end_block: ~
+
+# The `fuel_client` denotes the address (host, port combination) of the running Fuel client
+# that you would like your indexer to index events from. In order to use this per-indexer
+# `fuel_client` option, the indexer service at which your indexer is deployed will have to run
+# with the `--indexer_net_config` option.
 fuel_client: ~
+
+# The contract_id specifies which particular contract you would like your index to subscribe to.
+contract_id: ~
+
+# The graphql_schema field contains the file path that points to the GraphQL schema for the
+# given index.
 graphql_schema: examples/hello-world/hello-world/schema/hello_world.schema.graphql
+
+# The module field contains a file path that points to code that will be run as an executor inside
+# of the indexer.
+# Important: At this time, wasm is the preferred method of execution.
 module:
   wasm: target/wasm32-unknown-unknown/release/hello_world.wasm
-metrics: ~
-contract_id: ~
-start_block: ~
-end_block: ~
-resumable: true
+
+# The resumable field contains a boolean that specifies whether or not the indexer should, synchronise
+# with the latest block if it has fallen out of sync.
+resumable: true