docs: Move spec to cosmwasm documentation

CosmWasm · Oct 17, 2024 · a0deebf · a0deebf
1 parent 198f254
commit a0deebf
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 447 deletions.
diff --git a/Makefile b/Makefile
@@ -48,6 +48,11 @@ build-libwasmvm:
 	cp libwasmvm/target/release/$(SHARED_LIB_SRC) internal/api/$(SHARED_LIB_DST)
 	make update-bindings
 
+# use release build to actually ship - smaller and much faster
+.PHONY: doc-rust
+doc-rust:
+	(cd libwasmvm && cargo doc --no-deps --open)
+
 .PHONY: build-go
 build-go:
 	go build ./...

diff --git a/README.md b/README.md
@@ -148,13 +148,9 @@ which for example excludes all 32 bit systems.
 
 ## Docs
 
-Run `(cd libwasmvm && cargo doc --no-deps --open)`.
-
-## Design
-
-Please read the [Documentation](./spec/Index.md) to understand both the general
-[Architecture](./spec/Architecture.md), as well as the more detailed
-[Specification](./spec/Specification.md) of the parameters and entry points.
+The general wasmvm documentation can be found (HERE)[]. To generate and show
+the Rust part documentation you can run `make doc-rust`. 
+# TODO tkulik: Place a link to the vercel docs here
 
 ## Development
 

diff --git a/spec/Architecture.md b/spec/Architecture.md
diff --git a/spec/Index.md b/spec/Index.md