PeachCloud/peach-devdocs
0
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Mixd readme #1

Merged
mixmix merged 4 commits from mixd-readme into master 2019-11-11 08:16:08 +00:00
Conversation 2 Commits 4 Files Changed 3
+30 -15
mixmix commented 2019-11-09 08:19:55 +00:00 (Migrated from github.com)
Copy Link
Copy Source

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)
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)
Copy Link
Copy Source

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

see also : https://github.com/peachcloud/peach-devdocs/issues/2
mycognosist commented 2019-11-11 08:15:54 +00:00 (Migrated from github.com)
Copy Link
Copy Source

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!

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.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something is not working
 documentation
duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 maintenance
Pruning and weeding
 peach-lib
peach-network
peach-oled
peach-stats
peach-web
question
More information is needed
 refactor
Code rewrite
 wontfix
This won't be fixed
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
glyph (glyph) notplants
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: PeachCloud/peach-devdocs#1