update workflows, embed

.github/workflows/docs-generate.yml

@@ -0,0 +1,31 @@
+name: Docs Generate
+
+on:
+  pull_request:
+    paths:
+      - 'docs/**'
+
+jobs:
+  embed:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.22.7'
+
+      - name: make gen
+        run:
+          cd docs/ && make gen -B
+
+      - name: Check if there is a diff
+        run: |
+          diff=$(git status --porcelain)
+          if [[ $diff ]]; then
+              echo 'Please run `make build` to update the sidebar.js file!'
+              exit 1
+          fi

.github/workflows/docs-sidebar-linter.yml

@@ -1,4 +1,4 @@
-name: Update Sidebar
+name: Docs Sidebar
 
 on:
   pull_request:

.github/workflows/docs-url-linter.yml

@@ -1,4 +1,4 @@
-name: Docs Linter
+name: Docs
 
 on:
   push:
@@ -9,7 +9,7 @@ on:
       - "docs/**"
 
 jobs:
-  build:
+  lint-urls:
     runs-on: ubuntu-latest
 
     steps:

docs/Makefile

@@ -1,16 +1,19 @@
 MISC_DOCS=../misc/docs
 
-build: $(MISC_DOCS)/docusaurus/static/sidebar.json
+build: $(MISC_DOCS)/docusaurus/static/sidebar.json gen
 
 $(MISC_DOCS)/docusaurus/static/sidebar.json: README.md
 	go build -C $(MISC_DOCS)/tools/indexparser -o ./build
 	$(MISC_DOCS)/tools/indexparser/build -path ../docs/README.md > $(MISC_DOCS)/docusaurus/static/sidebar.json
 
-# Run the linter for the docs/ folder
+# Run the link linter for the docs/ folder
 lint:
 	go build -C $(MISC_DOCS)/tools/linter -o ./build
 	$(MISC_DOCS)/tools/linter/build -path ../docs
 
+gen:
+	go run -modfile ../misc/devdeps/go.mod github.com/campoy/embedmd -w `find . -name "*.md"`
+
 dev:
 	cd $(MISC_DOCS)/docusaurus/ && yarn start
 

docs/README.md

@@ -66,4 +66,4 @@ Find references for package APIs, RPC endpoints, network configurations, and mor
   - [tx-indexer](https://github.com/gnolang/tx-indexer)
   - [tx-archive](https://github.com/gnolang/tx-archive)
   - [gno-js-client](https://github.com/gnolang/gno-js-client)
-  - [tm2-js-client](https://github.com/gnolang/tm2-js-client)
+  - [tm2-js-client](https://github.com/gnolang/tm2-js-client)

docs/concepts/realms.md

@@ -148,4 +148,4 @@ std.CurrentRealm() => Realm {
 }
 ```
 
-Check out the realm reference page [here](../reference/std.md#realm).
+Check out the realm reference page [here](../reference/std.md#realm).

docs/concepts/stdlibs/events.md

@@ -49,4 +49,4 @@ data:
 ```
 
 You can fetch the ABCI response of a specific block by using the `/block_results` 
-RPC endpoint.
+RPC endpoint.

docs/concepts/stdlibs/overview.md

@@ -73,4 +73,4 @@ where you cloned the Gno repository.
 
 ```sh
 export GNOROOT=$HOME/gno
-```
+```

docs/concepts/testnets.md

@@ -90,4 +90,4 @@ Release commit: [652dc7a](https://github.com/gnolang/gno/commit/652dc7a3a62ee043
 The first Gno testnet. Find archive data [here](https://github.com/gnolang/tx-exports/tree/main/test1.gno.land).
 
 Launch date: May 6th 2022
-Release commit: [797c7a1](https://github.com/gnolang/gno/commit/797c7a132d65534df373c63b837cf94b7831ac6e)
+Release commit: [797c7a1](https://github.com/gnolang/gno/commit/797c7a132d65534df373c63b837cf94b7831ac6e)

docs/getting-started/becoming-a-gnome.md

@@ -74,4 +74,4 @@ communication, you can grow as a contributor and leave a lasting impact.
 
 Becoming a Gnome is a journey of learning, collaboration, and 
 creativity. By embracing these principles and finding ways to showcase your work,
-you can help shape the future of gno.land while staying true to your own path.
+you can help shape the future of gno.land while staying true to your own path.

docs/getting-started/developing-locally/running-testing-gno.md

@@ -167,4 +167,4 @@ That's it 🎉
 
 You've successfully run local tests and expressions using the `gno` binary. 
 Next, let's jump into how to create a Gno key pair, which is crucial to deploying
-your code and interacting with the gno.land blockchain.
+your code and interacting with the gno.land blockchain.

docs/getting-started/exploring-gnoland.md

@@ -106,4 +106,4 @@ blockchain environment.
 
 Get started writing Gno code by visiting the next tutorial.
 
-[^1]: gno.land also has a standard library, which is [built directly into the GnoVM](https://github.com/gnolang/gno/tree/master/gnovm/stdlibs).
+[^1]: gno.land also has a standard library, which is [built directly into the GnoVM](https://github.com/gnolang/gno/tree/master/gnovm/stdlibs).

docs/getting-started/writing-gno.md

@@ -149,4 +149,4 @@ found online.
 ## Conclusion
 
 Congratulations! You've just created your first Gno application, along with tests
-to confirm it's working properly.
+to confirm it's working properly.

docs/reference/network-config.md

@@ -10,4 +10,4 @@ All networks follow the same pattern for websocket connections:
 
 ```shell
 wss://<rpc-endpoint:port>/websocket
-```
+```

docs/reference/rpc-endpoints.md

@@ -1 +1 @@
-# RPC Endpoints
+# RPC Endpoints

docs/reference/std.md

@@ -747,4 +747,4 @@ Creates a new code realm for testing purposes.
 ```go
 path := "gno.land/r/demo/boards"
 codeRealm := std.NewCodeRealm(path)
-```
+```