From 030238e07e1ad31a9b76be3e665353b83b75b2b6 Mon Sep 17 00:00:00 2001
From: colindickson <colin.dickson@gmail.com>
Date: Tue, 31 Oct 2023 15:57:28 -0400
Subject: [PATCH] add docs

---
 solana-explorer/substreams.yaml | 22 +++++++++++++++-------
 1 file changed, 15 insertions(+), 7 deletions(-)

diff --git a/solana-explorer/substreams.yaml b/solana-explorer/substreams.yaml
index 60b21d0..2d82e22 100644
--- a/solana-explorer/substreams.yaml
+++ b/solana-explorer/substreams.yaml
@@ -2,6 +2,8 @@ specVersion: v0.1.0
 package:
   name: "solana_explorer"
   version: v0.1.0
+  doc: |
+    This packages holds simple modules to allow you to explore the Solana data model.
 
 imports:
   solana: https://github.com/streamingfast/firehose-solana/releases/download/v0.1.1/solana-v0.1.1.spkg
@@ -19,19 +21,23 @@ binaries:
     file: ./target/wasm32-unknown-unknown/release/substreams.wasm
 
 modules:
-  - name: map_block_meta
-    kind: map
-    inputs:
-      - source: sf.solana.type.v1.Block
-    output:
-      type: proto:sol.block_meta.v1.BlockMeta
-
   - name: map_block_full
     kind: map
     inputs:
       - source: sf.solana.type.v1.Block
     output:
       type: proto:sf.solana.type.v1.Block
+    doc: |
+      `map_block_full` allows you to view a complete block, as received by a Substreams module
+
+  - name: map_block_meta
+    kind: map
+    inputs:
+      - source: sf.solana.type.v1.Block
+    output:
+      type: proto:sol.block_meta.v1.BlockMeta
+    doc: |
+      `map_block_meta` allows you to view a basic information about a block
 
   - name: map_filter_instructions
     kind: map
@@ -40,6 +46,8 @@ modules:
       - source: sf.solana.type.v1.Block
     output:
       type: proto:sol.programs.v1.Instructions
+    doc: |
+      `map_filter_instructions` allows you to get instructions executed by a certain `program_id`, and returns the raw Instruction data model.
 
 params:
   map_filter_instructions: "program_id=Stake11111111111111111111111111111111111111"