Mixd readme #1

2019-11-09T08:19:55Z

mixmix commented

2019-11-09 08:19:55 +00:00

(Migrated from github.com)

Followed the instructions and got this going, but I thought I could streamline what's here a little:

removed some details about installing mdbook
- I noticed I skipped all your notes about requirements and just ran cargo install mdbook and it failed
- when I went through to the mdbook docs I actually read them and installed it carefully
- conclusion let's save space in our docs + increase clarity by relying on the source
split out development / build
added an image
- it's a 44kb image of the peachcloud interface
- it really grounds the docs
pointed to a temporary version published online
- https://mixmix.github.io/peach-devdocs/
- this is temporary and should definitely be over-written
- I note the search index js file changes every time and is quite large so if you're gonna use gh-pages in the future recommend force-pushing every time
- hashbase.io could be nice (scuttlebutt has a subscription there)

Followed the instructions and got this going, but I thought I could streamline what's here a little: 1. **removed some details about installing `mdbook`** - I noticed I skipped all your notes about requirements and just ran `cargo install mdbook` and it failed - when I went through to the `mdbook` docs I actually read them and installed it carefully - conclusion let's save space in our docs + increase clarity by relying on the source 2. **split out development / build** 3. **added an image** - it's a 44kb image of the peachcloud interface - it really grounds the docs 4. **pointed to a temporary version published online** - https://mixmix.github.io/peach-devdocs/ - this is temporary and should definitely be over-written - I note the search index js file changes every time and is quite large so if you're gonna use gh-pages in the future recommend force-pushing every time - hashbase.io could be nice (scuttlebutt has a subscription there)

❤️ 1

mixmix commented

2019-11-10 08:56:58 +00:00

(Migrated from github.com)

see also : https://github.com/peachcloud/peach-devdocs/issues/2

mycognosist commented

2019-11-11 08:15:54 +00:00

(Migrated from github.com)

Thanks so much for taking the time to review and submit this, @mixmix! I like your "let's save space in our docs + increase clarity by relying on the source" approach. Adding the interface photo really balances things out. Your notes on publishing are well received. Thanks again!

Sign in to join this conversation.

No reviewers