docs: add README for snippets

apps/docs-snippets2/README.md

@@ -0,0 +1,26 @@
+# `docs-snippets`
+
+**docs-snippets** is a private package for generating snippets for the Fuel documentation site.
+
+
+# Table of contents
+
+- [building](#building)
+- [running](#running)
+
+## Building
+
+This builds the snippets into testable scripts from the `src` folder and generates the Typegen `types` in the `typegend` folder. All test scripts end with a `.test.ts` suffix.
+```sh
+pnpm build
+```
+
+## Testing
+
+This will build the snippets and run the generated tests. To specific a particular environment for a test, the snippet should be named as `{name}.{environment}.test.ts`. e.g. `deploy-contract.node.test.ts`
+
+If no environment is specified, it will run in the browser and node environments by default.
+
+```sh
+pnpm test
+```