bafu / docs

Documentation repository for all Textile projects πŸ“š

Home Page:https://docs.textile.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Textile Docs (docs)

Made by Textile Chat on Slack

Documentation repository for all Textile projects πŸ“š

Join us on our public Slack channel for news, discussions, and status updates. View the docs live at https://docs.textile.io.

Check out our blog for the latest posts and announcements.

Table of Contents

Getting Started

Requirements

  • python >= 3.6.0
  • pip >= 19.0
  • wget >= 1.0
  • bash >= 3

Commands

Install dependencies:

./scripts/setup

Build docs

./scripts/build

Serve locally

./scripts/serve

Deploy to docs.textile.io

./scripts/deploy

Update contributors

cd scripts/contributors/
./update.py

Update CLI Docs

cd scripts/cli/
./build

Maintainer

Carson Farmer

Contributing

Contribute to the Textile Docs with any additions or questions you have about Textile and its various projects. A good example would be asking, "What is a thread?". If you don't know a term, odds are someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make Textile even better.

Before you get started, be sure to read our contributors guide and our contributor covenant code of conduct.

Contributors

License

MIT

About

Documentation repository for all Textile projects πŸ“š

https://docs.textile.io/

License:MIT License


Languages

Language:HTML 48.9%Language:Jupyter Notebook 40.2%Language:Go 5.3%Language:Shell 2.8%Language:Python 1.3%Language:CSS 0.8%Language:TypeScript 0.7%Language:JavaScript 0.0%