Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 2.07 KB

README.md

File metadata and controls

95 lines (61 loc) · 2.07 KB
Raw

Permaweb Cookbook

The Permaweb Cookbook is meant to house small digestible code snippets for someone that has no experience with blockchain or Permaweb to be able to grab and go.

Contributing

The Cookbook is welcome to any and all contributions. Please refer to the project's style when contributing new snippets of code.

Structure

Currently we have "topics" under /docs and the code for those topics.

References

References are an overarching topic with a list of references of how to do things under that topic. The general structure is the following:

Code Reference Title

Short Summary

Code Snippet

Guides

Guides are longer form informational documentation on various topics. The general structure for writing a guide is the following:

Brief Summary/TLDR

Fact Sheet

Deep Dive

Other Resources

Building

You need to have node v16 installed - https://nodejs.org

cd docs
yarn
yarn dev

Translation

Learn more about translating the cookbook here

Audit

If you find a tool or guide out of date, please create an issue on the project board so that it can be removed or updated.

Committing

We are using conventional commits for this repository.

To choose a task or make your own, do the following:

  1. Add an issue for the task and assign it to yourself or comment on the issue
  2. Make a draft PR referencing the issue.

The general flow for making a contribution:

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

You can find tasks on the project board or create an issue and assign it to yourself.

Happy Cooking!

Deploy Instructions

touch wallet.json
# add wallet info
cd docs
yarn deploy