Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

docs: consolidate API docs and update readme files #2944

Merged
merged 16 commits into from
Mar 27, 2020

Conversation

achingbrain
Copy link
Member

Moves api docs into /docs folder similarly to how js-libp2p has organised their docs.

Tries to trim readmes down a bit to make them more digestible and adds links to futher information on different topics.

Also reinstates dependency statuses.

@achingbrain achingbrain marked this pull request as ready for review March 25, 2020 18:00
README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
packages/interface-ipfs-core/README.md Show resolved Hide resolved
packages/interface-ipfs-core/README.md Show resolved Hide resolved
@achingbrain achingbrain merged commit 10e8682 into master Mar 27, 2020
@achingbrain achingbrain deleted the refactor/reorganise-readmes branch March 27, 2020 11:56
mistakia pushed a commit to mistakia/js-ipfs that referenced this pull request Apr 3, 2020
* docs: consolidate API docs and update readme files

Moves api docs into `/docs` folder similarly to how js-libp2p has organised
their docs.

Tries to trim readmes down a bit to make them more digestible and
adds links to futher information on different topics.

Also reinstates dependency statuses.

Co-authored-by: Hugo Dias <[email protected]>
SgtPooki referenced this pull request in ipfs/js-kubo-rpc-client Aug 18, 2022
* docs: consolidate API docs and update readme files

Moves api docs into `/docs` folder similarly to how js-libp2p has organised
their docs.

Tries to trim readmes down a bit to make them more digestible and
adds links to futher information on different topics.

Also reinstates dependency statuses.

Co-authored-by: Hugo Dias <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants