Uh oh!
There was an error while loading. Please reload this page.
Build markdown API docs for JS and Go packages - #43
Conversation
ghost
commented
Nov 17, 2017
magik6k
left a comment
There was a problem hiding this comment.
LGTM, though in future it would be nice to split this into sections a bit more.
BTW, there is https://github.com/ipfs/docs/tree/master/content/api directory for APIs
magik6k
commented
Nov 17, 2017
Oh, and for Go the links in index don't work |
ghost
commented
Nov 17, 2017
We should have much more package docs than just js-ipfs-api and go-ipfs-api though (these were just examples). /api can hold the HTTP docs and concepts -- but yeah this just again hints at the huge confusion of terms that we've let grow over the years. When we say API, wtf do we actually mean? Core API, HTTP API, :5001, the *-api packages? But that's for another discussion.
Yeah I noticed that too -- something to do with Hugo's markdown renderer. Something to fix in one of the next few PRs :) |
ghost
commented
Nov 17, 2017
We can do that later. I think we shouldn't start with an empty structure skeleton and then fill it with content -- we should do it the other way around: develop structure as we add content |
This hacky little script builds API reference docs in markdown for a given JS or Go package. It's not wired up to the build yet since it depends on a change in aegir.
Examples:
These end up in
content/pkg/{js,go}-ipfs-apiwhere they're picked up by Hugo, which renders them athttps://docsdev.ipfs.team/pkg/{js,go}-ipfs-api.These currently both render godoc2md's and documentation.js's default markdown templates -- we can customize them as we see fit.