Skip to content
This repository has been archived by the owner on Jul 5, 2021. It is now read-only.

Improve install and docs page #227

Closed
daviddias opened this issue Sep 3, 2017 · 4 comments
Closed

Improve install and docs page #227

daviddias opened this issue Sep 3, 2017 · 4 comments
Labels
dif/easy Someone with a little familiarity can pick up

Comments

@daviddias
Copy link
Contributor

daviddias commented Sep 3, 2017

Currently, the Website makes no reference to js-ipfs and therefore misses a ton of examples that were created.

I want to propose the following changes:

  • Update sidebar to list:
    • Install steps for go-ipfs and js-ipfs
    • Examples for both implementations
    • rename API to HTTP-API
    • create Core-API
    • See Fig 1
  • Add to the examples page all of these: https://github.com/ipfs/js-ipfs/tree/master/examples (or at least pointers)
  • Have a Live Examples page with:
    • A pad
    • A video playing
    • A https://golang.org/ like env where people can play with a live go-ipfs daemon
    • A chat

Figure 1
image

@daviddias daviddias added dif/easy Someone with a little familiarity can pick up enhancement labels Sep 3, 2017
@victorb
Copy link
Contributor

victorb commented Nov 7, 2017

A https://golang.org/ like env where people can play with a live go-ipfs daemon

Might be hard to actually implement unless we can compile the go-ipfs implementation to JS. Otherwise we would need to dynamically start daemons and it could probably be abused easily.

However, a sandbox for a js-ipfs daemon would be really nice, + can be used for reporting issues if we can allow people to save their code.

@lidel
Copy link
Contributor

lidel commented Oct 5, 2018

AFAIK this can be closed due to #272
If something is missing at http://docs.ipfs.io it should be tracked in https://github.com/ipfs/docs/

@pkafei
Copy link

pkafei commented Feb 19, 2019

related to issue #293

We will add basic instructions for both the JavaScript and Go API. Not sure what would be the best way to visually present both API's without confusing user.

@meiqimichelle
Copy link
Contributor

While we may add some of the ideas raised here to an install section on the homepage (as per #299), the issues originally raised in this, erm, issue were obviated by #272 (our documentation looks and behaves entirely differently than when @daviddias originally suggested these changes). Closing.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dif/easy Someone with a little familiarity can pick up
Projects
None yet
Development

No branches or pull requests

5 participants