diff --git a/README.md b/README.md index 356c108..3d4f384 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ -# OpenBazaar Documenation +# OpenBazaar Documentation -This repo is a work in progress. The goal is to have all the mkdocs documenation files for docs.openbazaar.org. Then docs.openbazaar.org can load files directly from master. +This repo is a work in progress. The goal is to have all the mkdocs documentation files in this repo for [docs.openbazaar.org](docs.openbazaar.org). Then [docs.openbazaar.org](docs.openbazaar.org) can load files directly from master. -Help is appreciated. +There is a #documentation_2-0 channel on the OpenBazaar Slack if you have any questions about this repo. You can join the OpenBazaar Slack [here](http://slack.openbazaar.org). + +If you are new to OpenBazaar, the easiest way to start contributing to this documentation repo is to fork it, define some term(s) in the [Glossary](docs/glossary.md) and make a pull request. diff --git a/docs/glossary.md b/docs/glossary.md index 2a40ef7..fcf6a40 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -1 +1,9 @@ -Please help build this out at https://github.com/OpenBazaar/docs/ +# Glossary + +This is a work in progress. This is intended to define any terms that users or developers may be confused about when interacting with the OpenBazaar software. + +**Hierarchical Deterministic Wallet** - Add definition + +**IPFS** - Add definition + +**Multi-signature address** - Add definition diff --git a/docs/protocol/go-resources.md b/docs/protocol/go-resources.md new file mode 100644 index 0000000..681d7ad --- /dev/null +++ b/docs/protocol/go-resources.md @@ -0,0 +1,4 @@ +# Go resources + +The OpenBazaar server is coded in Go. Go is a C-like language with similar expression syntax, control-flow statements and programs that compile to efficient machine code. It was released by a team at Google in 2009. +