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

Hard to find the docs/specs for core api #13

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

Hard to find the docs/specs for core api #13

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

Comments

@SidHarder
Copy link

SidHarder commented Mar 7, 2017

Currently the “docs” link on ipfs.io links to docs for http api. Very hard to find the docs/specs for core api

The plan:

  1. Make a landing page README in https://github.com/ipfs/interface-ipfs-core/tree/master/API that provides a clear path into the documentation for all the modules
  2. Update the readme in https://github.com/ipfs/interface-ipfs-core/ to call out the fact that there are docs, include a link to /API/README.md
  3. Update ipfs.io/docs to include a link to the core API docs
@flyingzumwalt
Copy link

At the very least, it should link to the info in https://github.com/ipfs/interface-ipfs-core/tree/master/API

@ghost ghost added writing labels Mar 10, 2017
@ghost ghost unassigned flyingzumwalt Mar 10, 2017
@flyingzumwalt
Copy link

The plan:

  1. Make a landing page README in https://github.com/ipfs/interface-ipfs-core/tree/master/API that provides a clear path into the documentation for all the modules
  2. Update the readme in https://github.com/ipfs/interface-ipfs-core/ to call out the fact that there are docs, include a link to /API/README.md
  3. Update ipfs.io/docs to include a link to the core API docs

@Mr0grog
Copy link
Collaborator

Mr0grog commented Aug 23, 2018

I think this has all mostly been done, and https://docs.ipfs.io links to interface-ipfs-core under “Reference → Commands & API → JS & Go Libraries”

If there’s work specific to interface-ipfs-core, I think we should just open issues/PRs there (unless it’s tightly coupled with something that has to happen on the docs site here.)

Please comment if I’ve mis-judged this and we should re-open.

@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

3 participants