tea/browsertrix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
9624cb6007
browsertrix/docs/index.md
Henry Wilkinson a74d88dcda
mkdocs setup (deploy, dev, user-guide) (#375) 
* Initial docs move
* Setup mkdocs
* Adds instructions for building docs
* add new deployment docs, local and prod
* set up three sections: deployment, dev and user guide
* remove old deployment docs
* ci: mkdocs gh-pages publish

Co-authored-by: sua yoo <sua@suayoo.com>
Co-authored-by: Ilya Kreymer <ikreymer@gmail.com>
2022-12-05 16:41:37 -08:00

1.0 KiB
Raw Blame History

Welcome

Welcome to the Browsertrix Cloud official user guide and developer docs. These docs will contain the following sections.

  • Deployment Guide - Info on how to install and deploy Browsertrix Cloud locally or in the cloud.
  • Developer Docs - for info on how to developing Browsertrix Cloud itself.
  • User Guide - for info on how to use Browsertrix Cloud system.

If you are unfamiliar with Browsertrix Cloud, please check out our website or the main repository at https://github.com/webrecorder/browsertrix-cloud

Our docs are still under construction. If you find something missing, chances are we haven't gotten around to writing that part yet. If you find typoes or something isn't clear or seems incorrect, please open an issue and we'll try to make sure that your questions get answered here in the future!