docs: publish api docs (#181)

Update project config to publish api docs
ipfs · Dec 16, 2022 · 64f8473 · 64f8473
1 parent e583cce
commit 64f8473
Show file tree

Hide file tree

Showing 15 changed files with 127 additions and 54 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
+node_modules
 dist
+.docs
+.coverage
 node_modules
 package-lock.json
-docs
-types
-.nyc_output
-*.log
+yarn.lock
diff --git a/.npmrc b/.npmrc
@@ -1 +1,2 @@
-engine-strict = true
+; package-lock with tarball deps breaks lerna/nx - remove when https://github.com/semantic-release/github/pull/487 is merged
+package-lock=false
diff --git a/README.md b/README.md
@@ -1,10 +1,9 @@
 # ipfs-interfaces <!-- omit in toc -->
 
-[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
-[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
-[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > TypeScript interfaces used by IPFS internals
 
@@ -13,6 +12,7 @@
 - [Structure](#structure)
 - [Packages](#packages)
 - [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute-1)
 
@@ -36,6 +36,10 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
 
+## API Docs
+
+- <https://ipfs.github.io/js-ipfs-interfaces>
+
 ## License
 
 Licensed under either of
@@ -45,8 +49,12 @@ Licensed under either of
 
 ## Contribute
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
 
-This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
+
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
diff --git a/lerna.json b/lerna.json
@@ -1,13 +1,10 @@
 {
-  "lerna": "4.0.0",
+  "lerna": "6.0.0",
   "useWorkspaces": true,
   "version": "independent",
   "command": {
     "run": {
       "stream": true
     }
-  },
-  "packages": [
-    "packages/*"
-  ]
+  }
 }
diff --git a/package.json b/package.json
@@ -29,10 +29,13 @@
     "clean": "lerna run clean",
     "build": "lerna run build",
     "lint": "lerna run lint",
+    "docs": "NODE_OPTIONS=--max_old_space_size=4096 aegir docs",
+    "docs:no-publish": "npm run docs -- --publish false",
     "dep-check": "lerna run dep-check",
-    "release": "lerna run --concurrency 1 release -- --"
+    "release": "npm run docs:no-publish && lerna run --concurrency 1 release && npm run docs"
   },
   "dependencies": {
+    "aegir": "^37.7.8",
     "lerna": "^6.0.0",
     "rimraf": "^3.0.2"
   },

diff --git a/packages/interface-blockstore-tests/README.md b/packages/interface-blockstore-tests/README.md
@@ -1,10 +1,9 @@
 # interface-blockstore-tests <!-- omit in toc -->
 
-[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
-[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
-[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Compliance tests for the blockstore interface
 
@@ -13,6 +12,7 @@
 - [Install](#install)
 - [Usage](#usage)
 - [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute-1)
 
@@ -46,6 +46,10 @@ PRs accepted.
 
 Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
 
+## API Docs
+
+- <https://ipfs.github.io/js-ipfs-interfaces/modules/interface_blockstore_tests.html>
+
 ## License
 
 Licensed under either of
@@ -55,8 +59,12 @@ Licensed under either of
 
 ## Contribute
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
+
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
+
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 
-This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
diff --git a/packages/interface-blockstore-tests/package.json b/packages/interface-blockstore-tests/package.json
@@ -150,12 +150,15 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "aegir": "^37.5.0",
+    "aegir": "^37.7.8",
     "interface-blockstore": "^3.0.0",
     "it-all": "^1.0.2",
     "it-drain": "^1.0.1",
     "it-length": "^1.0.2",
     "multiformats": "^10.0.0",
     "uint8arrays": "^4.0.2"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.js"
   }
 }
diff --git a/packages/interface-blockstore/README.md b/packages/interface-blockstore/README.md
@@ -1,17 +1,17 @@
 # interface-blockstore <!-- omit in toc -->
 
-[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
-[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
-[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > An interface for storing and retrieving blocks
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
 - [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute-1)
 
@@ -29,6 +29,10 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
 
+## API Docs
+
+- <https://ipfs.github.io/js-ipfs-interfaces/modules/interface_blockstore.html>
+
 ## License
 
 Licensed under either of
@@ -38,8 +42,12 @@ Licensed under either of
 
 ## Contribute
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
 
-This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
+
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
diff --git a/packages/interface-blockstore/package.json b/packages/interface-blockstore/package.json
@@ -19,7 +19,7 @@
   "types": "./dist/src/index.d.ts",
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -131,6 +131,9 @@
     "multiformats": "^10.0.0"
   },
   "devDependencies": {
-    "aegir": "^37.5.0"
+    "aegir": "^37.7.8"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
   }
 }
diff --git a/packages/interface-datastore-tests/README.md b/packages/interface-datastore-tests/README.md
@@ -1,10 +1,9 @@
 # interface-datastore-tests <!-- omit in toc -->
 
-[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
-[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
-[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > Compliance tests for the datastore interface
 
@@ -13,6 +12,7 @@
 - [Install](#install)
 - [Usage](#usage)
 - [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute-1)
 
@@ -46,6 +46,10 @@ PRs accepted.
 
 Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
 
+## API Docs
+
+- <https://ipfs.github.io/js-ipfs-interfaces/modules/interface_datastore_tests.html>
+
 ## License
 
 Licensed under either of
@@ -55,8 +59,12 @@ Licensed under either of
 
 ## Contribute
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
+
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
+
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 
-This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
diff --git a/packages/interface-datastore-tests/package.json b/packages/interface-datastore-tests/package.json
@@ -150,11 +150,14 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "aegir": "^37.5.0",
+    "aegir": "^37.7.8",
     "interface-datastore": "^7.0.0",
     "iso-random-stream": "^2.0.0",
     "it-all": "^1.0.2",
     "it-drain": "^1.0.1",
     "uint8arrays": "^4.0.2"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.js"
   }
 }
diff --git a/packages/interface-datastore/README.md b/packages/interface-datastore/README.md
@@ -1,23 +1,24 @@
 # interface-datastore <!-- omit in toc -->
 
-[![ipfs.io](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io)
-[![IRC](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![Discord](https://img.shields.io/discord/806902334369824788?style=flat-square)](https://discord.gg/ipfs)
+[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
+[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
 [![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-interfaces.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-interfaces)
-[![CI](https://img.shields.io/github/workflow/status/ipfs/js-ipfs-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-interfaces/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs-interfaces/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
 > datastore interface
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Implementations](#implementations)
   - [Test suite](#test-suite)
   - [Aborting requests](#aborting-requests)
   - [Concurrency](#concurrency)
   - [Keys](#keys)
 - [API](#api)
 - [Contribute](#contribute)
+- [API Docs](#api-docs)
 - [License](#license)
 - [Contribute](#contribute-1)
 
@@ -27,6 +28,14 @@
 $ npm i interface-datastore
 ```
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `InterfaceDatastore` in the global namespace.
+
+```html
+<script src="https://unpkg.com/interface-datastore/dist/index.min.js"></script>
+```
+
 ## Implementations
 
 - Backed Implementations
@@ -123,6 +132,10 @@ PRs accepted.
 
 Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
 
+## API Docs
+
+- <https://ipfs.github.io/js-ipfs-interfaces/modules/interface_datastore.html>
+
 ## License
 
 Licensed under either of
@@ -132,9 +145,13 @@ Licensed under either of
 
 ## Contribute
 
-Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-interfaces/issues).
+
+Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
+
+Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
 
-This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
 
 [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
 

diff --git a/packages/interface-datastore/package.json b/packages/interface-datastore/package.json
@@ -41,7 +41,7 @@
   },
   "files": [
     "src",
-    "dist/src",
+    "dist",
     "!dist/test",
     "!**/*.tsbuildinfo"
   ],
@@ -165,6 +165,9 @@
     "uint8arrays": "^4.0.2"
   },
   "devDependencies": {
-    "aegir": "^37.5.0"
+    "aegir": "^37.7.8"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts"
   }
 }