Thomas Osmonson
a62aa05677
|
4 years ago | |
---|---|---|
.github/workflows | 5 years ago | |
lib | 4 years ago | |
public | 4 years ago | |
src | 4 years ago | |
types | 5 years ago | |
.eslintrc.js | 5 years ago | |
.gitignore | 4 years ago | |
.prettierrc | 5 years ago | |
.vercelignore | 4 years ago | |
README.md | 4 years ago | |
babel.config.js | 4 years ago | |
next-env.d.ts | 5 years ago | |
next.config.js | 4 years ago | |
package.json | 4 years ago | |
tsconfig.json | 5 years ago | |
yarn.lock | 4 years ago |
README.md
Welcome to the Blockstack documentation repo!
This readme describes the project file organization and steps for building the Blockstack documentation site found at docs.blockstack.comhttps://docs.blockstack.com).
You can also make use of the Edit this page on GitHub link found at the bottom of every page in the docs.
Running and building the site locally
If you are interested in contributing to the site and making changes, please refer to our contributing guide here.
Generated documentation
To generate the CLI json manually
The src/_data/cliRef.json
file is generated from the blockstack-cli
subcommand docs
. This data file is consumed by the _includes/commandline.md
file which is used to serve up the reference.
-
Install the latest version of the cli according to the instructions at: https://github.com/blockstack/cli-blockstack
-
Generate the json for the cli in the
docs.blockstack
repo.$ blockstack-cli docs | python -m json.tool > src/_data/cliRef.json
-
Make sure the generated docs are clean by building the documentation.
If you run into any problem in the generation usually it results from a problem in the repo. You can make a pull request back to the repo to fix anything.
Clarity Reference
As of 8/12/19 Clarity is in the develop branch of core. You can build the Clarity command line from the Docker image. core/src/vm/docs/mod.rs
-
Pull the latest developer preview from the Docker Hub.
$ docker pull blockstack/blockstack-core:clarity-developer-preview
-
Build the lastest JSON.
docker run -it blockstack/blockstack-core:clarity-developer-preview blockstack-core docgen | jsonpp > ~/repos/docs.blockstack/src/_data/clarityRef.json
-
Build the documentation and verify the Clarity reference is building correctly.
-
Make changes in core
-
Build the docker image
-
Run doc gen with the new image
$ docker run --name docsbuild -it blockstack-test blockstack-core docgen | jsonpp > ~/repos/docs.blockstack/src/_data/clarityRef.json
This generates the JSON source files which are consumed through Liquid templates into markdown.
-
Rebuild the documentation site with Jekyll.
-
Review the changes in the Clarity documentation to ensure that no breaking changes were introduced through code changes.
-
If you find the documentation is no longer formatting correctly or there are errors in the reference, create a PR against the
blockstack-core
repo.
View and test the clarity cli
You can view the source code.
-
Pull the Stacks Node clarity-developer-preview image from Docker Hub.
$ docker pull blockstack/blockstack-core:clarity-developer-preview
-
Start the Stacks Node test environment with a Bash shell.
$ docker run -it -v $HOME/blockstack-dev-data:/data/ blockstack/blockstack-core:clarity-developer-preview bash
The command launches a container with the Clarity test environment and opens a bash shell into the container.
-
Run the clarity-cli in the shell.
root@5b9798633251:/src/blockstack-core# clarity-cli Usage: clarity-cli [command] where command is one of: initialize to initialize a local VM state database. mine_block to simulated mining a new block. get_block_height to print the simulated block height. check to typecheck a potential contract definition. launch to launch a initialize a new contract in the local state database. eval to evaluate (in read-only mode) a program in a given contract context. eval_raw to typecheck and evaluate an expression without a contract or database context. repl to typecheck and evaluate expressions in a stdin/stdout loop. execute to execute a public function of a defined contract. generate_address to generate a random Stacks public address for testing purposes.