Skip to content
This repository was archived by the owner on Jun 2, 2020. It is now read-only.

"Getting Started" page improvements #8

Closed
SidHarder opened this issue Mar 7, 2017 · 3 comments
Closed

"Getting Started" page improvements #8

SidHarder opened this issue Mar 7, 2017 · 3 comments

Comments

@SidHarder
Copy link

SidHarder commented Mar 7, 2017

@victorbjelkholm This was assigned to you from here https://github.com/ipfs/docs/blob/master/meeting-notes/2017-03-03-pre-prep-call.md. Could you add some details to this.

@victorb
Copy link
Contributor

victorb commented Mar 9, 2017

Sure. Many of our modules are missing a "Getting Started" page, kind of like a Quickstart, where first-time users can understand how you initially use the module. This is a problem in both go and js implementation of IPFS, where you would be forced to look at the tests to even see the most basic usage.

Also, together with that, we're lacking some more advanced, specific examples on how to achieve certain things in the best way, the examples.

@SidHarder does that clarify enough?

@SidHarder SidHarder changed the title Getting started and examples "Getting Started" page improvement Mar 9, 2017
@SidHarder SidHarder changed the title "Getting Started" page improvement "Getting Started" page improvements Mar 9, 2017
@SidHarder
Copy link
Author

@victorbjelkholm Thanks :)

@flyingzumwalt flyingzumwalt modified the milestone: The Docs are Not a Disaster Mar 10, 2017
@ghost ghost added the writing label Mar 10, 2017
@victorb victorb removed their assignment Mar 13, 2017
@Mr0grog
Copy link
Collaborator

Mr0grog commented Aug 23, 2018

I’m closing this in favor of #60, which is a little newer and has more specifics. Please feel free to post here if we should re-open this.

@Mr0grog Mr0grog closed this as completed Aug 23, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants