docs: Fixes docs #77

whizzzkid · 2023-04-05T04:07:39Z

Addresses: #35

Fixing link backs from NPM
Fixing 404s
Adding helia demo day videos.

Supplemental:

404s

Getting links from: /
├───OK─── /modules.html
├───OK─── /modules/_helia_interface.html
├───OK─── /modules/_helia_interface._internal_.html
├───OK─── /modules/_helia_interop.html
├───OK─── /modules/helia.html
├───OK─── /modules/helia._internal_.html
Finished! 12 links found. 6 excluded. 0 broken.

Getting links from: /index.html
Finished! 12 links found. 12 excluded. 0 broken.

Getting links from: /modules.html
Finished! 15 links found. 15 excluded. 0 broken.

Getting links from: /modules/_helia_interface.html
├───OK─── https://github.com/ipfs/helia/blob/master/packages/interface/src/index.ts#L17
├───OK─── https://github.com/ipfs/helia
├───OK─── https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png
├───OK─── https://github.com/ipfs/helia/tree/main/packages/interface
├───OK─── https://ipfs.tech/
├───OK─── https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square
├───OK─── https://discuss.ipfs.tech/
├───OK─── https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square
├───OK─── https://codecov.io/gh/ipfs/helia
├───OK─── https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square
├───OK─── https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain
├───OK─── https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main&style=flat-square
├───OK─── https://ipfs.github.io/helia/modules/_helia_interface.html
├─BROKEN─ /modules/LICENSE-APACHE (HTTP_404)
├───OK─── http://www.apache.org/licenses/LICENSE-2.0
├─BROKEN─ /modules/LICENSE-MIT (HTTP_404)
├───OK─── http://opensource.org/licenses/MIT
├───OK─── https://github.com/ipfs/helia/issues
├───OK─── https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md
├───OK─── https://github.com/ipfs/community/blob/master/code-of-conduct.md
├───OK─── https://github.com/ipfs/community/blob/master/CONTRIBUTING.md
├───OK─── https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif
├───OK─── /interfaces/_helia_interface.GCOptions.html
├───OK─── /interfaces/_helia_interface.Helia.html
├───OK─── /interfaces/_helia_interface.InfoOptions.html
├───OK─── /types/_helia_interface.GcEvents.html
Finished! 56 links found. 30 excluded. 2 broken.

Getting links from: /modules/_helia_interface._internal_.html
├───OK─── /interfaces/_helia_interface._internal_.AddOptions.html
├───OK─── /interfaces/_helia_interface._internal_.Blocks.html
├───OK─── /interfaces/_helia_interface._internal_.IsPinnedOptions.html
├───OK─── /interfaces/_helia_interface._internal_.LsOptions.html
├───OK─── /interfaces/_helia_interface._internal_.Pin.html
├───OK─── /interfaces/_helia_interface._internal_.Pins.html
├───OK─── /interfaces/_helia_interface._internal_.RmOptions.html
├───OK─── /types/_helia_interface._internal_.AddPinEvents.html
├───OK─── /types/_helia_interface._internal_.DeleteBlockProgressEvents.html
├───OK─── /types/_helia_interface._internal_.DeleteManyBlocksProgressEvents.html
├───OK─── /types/_helia_interface._internal_.GetAllBlocksProgressEvents.html
├───OK─── /types/_helia_interface._internal_.GetBlockProgressEvents.html
├───OK─── /types/_helia_interface._internal_.GetManyBlocksProgressEvents.html
├───OK─── /types/_helia_interface._internal_.HasBlockProgressEvents.html
├───OK─── /types/_helia_interface._internal_.PutBlockProgressEvents.html
├───OK─── /types/_helia_interface._internal_.PutManyBlocksProgressEvents.html
Finished! 47 links found. 31 excluded. 0 broken.

Getting links from: /modules/_helia_interop.html
├───OK─── https://github.com/ipfs/helia/blob/master/packages/interop/src/index.ts#L1
Finished! 15 links found. 14 excluded. 0 broken.

Getting links from: /modules/helia.html
├───OK─── https://github.com/ipfs/helia/blob/master/packages/helia/src/index.ts#L28
├───OK─── https://ipfs.github.io/helia/modules/helia.html
├─BROKEN─ /modules/LICENSE-APACHE (HTTP_404)
├─BROKEN─ /modules/LICENSE-MIT (HTTP_404)
├───OK─── /interfaces/helia.DAGWalker.html
├───OK─── /interfaces/helia.HeliaInit.html
├───OK─── /functions/helia.createHelia.html
Finished! 56 links found. 49 excluded. 2 broken.

Getting links from: /modules/helia._internal_.html
├───OK─── /interfaces/helia._internal_.AddOptions.html
├───OK─── /interfaces/helia._internal_.Blocks.html
├───OK─── /interfaces/helia._internal_.GCOptions.html
├───OK─── /interfaces/helia._internal_.Helia.html
├───OK─── /interfaces/helia._internal_.IsPinnedOptions.html
├───OK─── /interfaces/helia._internal_.LsOptions.html
├───OK─── /interfaces/helia._internal_.Pin.html
├───OK─── /interfaces/helia._internal_.Pins.html
├───OK─── /interfaces/helia._internal_.RmOptions.html
├───OK─── /types/helia._internal_.AddPinEvents.html
├───OK─── /types/helia._internal_.DeleteBlockProgressEvents.html
├───OK─── /types/helia._internal_.DeleteManyBlocksProgressEvents.html
├───OK─── /types/helia._internal_.GcEvents.html
├───OK─── /types/helia._internal_.GetAllBlocksProgressEvents.html
├───OK─── /types/helia._internal_.GetBlockProgressEvents.html
├───OK─── /types/helia._internal_.GetManyBlocksProgressEvents.html
├───OK─── /types/helia._internal_.HasBlockProgressEvents.html
├───OK─── /types/helia._internal_.PutBlockProgressEvents.html
├───OK─── /types/helia._internal_.PutManyBlocksProgressEvents.html
Finished! 53 links found. 34 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface.GCOptions.html
├───OK─── https://libp2p.github.io/js-libp2p-interfaces/interfaces/_libp2p_interface_connection._internal_.AbortOptions.html
├───OK─── https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html
Finished! 23 links found. 21 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface.Helia.html
├───OK─── https://ipfs.github.io/js-stores/interfaces/datastore_core._internal_.Datastore.html
├───OK─── https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
├───OK─── https://libp2p.github.io/js-libp2p-interfaces/interfaces/_libp2p_interface_libp2p.Libp2p.html
Finished! 61 links found. 58 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface.InfoOptions.html
├───OK─── https://libp2p.github.io/js-libp2p-interfaces/types/_libp2p_interface_connection._internal_.PeerId.html
Finished! 23 links found. 22 excluded. 0 broken.

Getting links from: /types/_helia_interface.GcEvents.html
├───OK─── https://achingbrain.github.io/progress-events/interfaces/ProgressEvent.html
├───OK─── https://multiformats.github.io/js-multiformats/classes/cid.CID.html
├───OK─── https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
Finished! 24 links found. 21 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface._internal_.AddOptions.html
├───OK─── https://github.com/ipfs/helia/blob/master/packages/interface/src/pins.ts#L16
Finished! 29 links found. 28 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface._internal_.Blocks.html
├───OK─── https://ipfs.github.io/js-stores/interfaces/blockstore_core._internal_.Blockstore.html
├───OK─── https://github.com/ipfs/helia/blob/master/packages/interface/src/blocks.ts#L50
Finished! 50 links found. 48 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface._internal_.IsPinnedOptions.html
Finished! 34 links found. 34 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface._internal_.LsOptions.html
├───OK─── https://multiformats.github.io/js-multiformats/types/index.Version.html
Finished! 25 links found. 24 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface._internal_.Pin.html
Finished! 32 links found. 32 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface._internal_.Pins.html
├───OK─── https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator
Finished! 85 links found. 84 excluded. 0 broken.

Getting links from: /interfaces/_helia_interface._internal_.RmOptions.html
Finished! 34 links found. 34 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.AddPinEvents.html
Finished! 34 links found. 34 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.DeleteBlockProgressEvents.html
Finished! 35 links found. 35 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.DeleteManyBlocksProgressEvents.html
Finished! 34 links found. 34 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.GetAllBlocksProgressEvents.html
Finished! 34 links found. 34 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.GetBlockProgressEvents.html
├───OK─── https://ipfs.github.io/js-ipfs-bitswap/types/BitswapWantProgressEvents.html
Finished! 40 links found. 39 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.GetManyBlocksProgressEvents.html
Finished! 39 links found. 39 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.HasBlockProgressEvents.html
├───OK─── https://ipfs.github.io/js-ipfs-bitswap/types/BitswapNotifyProgressEvents.html
Finished! 40 links found. 39 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.PutBlockProgressEvents.html
Finished! 40 links found. 40 excluded. 0 broken.

Getting links from: /types/_helia_interface._internal_.PutManyBlocksProgressEvents.html
Finished! 39 links found. 39 excluded. 0 broken.

Getting links from: /interfaces/helia.DAGWalker.html
├───OK─── https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
Finished! 37 links found. 36 excluded. 0 broken.

Getting links from: /interfaces/helia.HeliaInit.html
├───OK─── https://multiformats.github.io/js-multiformats/interfaces/hashes_hasher.MultihashHasher.html
Finished! 50 links found. 49 excluded. 0 broken.

Getting links from: /functions/helia.createHelia.html
Finished! 26 links found. 26 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.AddOptions.html
Finished! 26 links found. 26 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.Blocks.html
Finished! 52 links found. 52 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.GCOptions.html
Finished! 38 links found. 38 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.Helia.html
Finished! 54 links found. 54 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.IsPinnedOptions.html
Finished! 36 links found. 36 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.LsOptions.html
Finished! 23 links found. 23 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.Pin.html
Finished! 28 links found. 28 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.Pins.html
Finished! 80 links found. 80 excluded. 0 broken.

Getting links from: /interfaces/helia._internal_.RmOptions.html
Finished! 36 links found. 36 excluded. 0 broken.

Getting links from: /types/helia._internal_.AddPinEvents.html
Finished! 36 links found. 36 excluded. 0 broken.

Getting links from: /types/helia._internal_.DeleteBlockProgressEvents.html
Finished! 37 links found. 37 excluded. 0 broken.

Getting links from: /types/helia._internal_.DeleteManyBlocksProgressEvents.html
Finished! 36 links found. 36 excluded. 0 broken.

Getting links from: /types/helia._internal_.GcEvents.html
Finished! 39 links found. 39 excluded. 0 broken.

Getting links from: /types/helia._internal_.GetAllBlocksProgressEvents.html
Finished! 36 links found. 36 excluded. 0 broken.

Getting links from: /types/helia._internal_.GetBlockProgressEvents.html
Finished! 42 links found. 42 excluded. 0 broken.

Getting links from: /types/helia._internal_.GetManyBlocksProgressEvents.html
Finished! 41 links found. 41 excluded. 0 broken.

Getting links from: /types/helia._internal_.HasBlockProgressEvents.html
Finished! 42 links found. 42 excluded. 0 broken.

Getting links from: /types/helia._internal_.PutBlockProgressEvents.html
Finished! 42 links found. 42 excluded. 0 broken.

Getting links from: /types/helia._internal_.PutManyBlocksProgressEvents.html
Finished! 41 links found. 41 excluded. 0 broken.

Finished! 1899 links found. 1806 excluded. 4 broken.

achingbrain

These changes need to be made in aegir, otherwise they will be overwritten the next time npx aegir check-project is run.

achingbrain · 2023-04-05T07:11:58Z

packages/helia/README.md

+- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/helia/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/helia/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)


Please PR: https://github.com/ipfs/aegir/blob/15f01ea4f27738a9483a464552286e0739d797b1/src/check-project/readme/license.js#L30-L31

achingbrain · 2023-04-05T07:12:19Z

packages/helia/README.md

@@ -4,7 +4,7 @@
  </a>
 </p>

-# helia <!-- omit in toc -->
+# [helia](https://github.com/ipfs/helia) <!-- omit in toc -->


Please PR: https://github.com/ipfs/aegir/blob/15f01ea4f27738a9483a464552286e0739d797b1/src/check-project/readme/header.js#L36

achingbrain · 2023-04-05T07:12:26Z

packages/interface/README.md

@@ -4,7 +4,7 @@
  </a>
 </p>

-# @helia/interface <!-- omit in toc -->
+# [@helia/interface](https://github.com/ipfs/helia/tree/main/packages/interface) <!-- omit in toc -->


https://github.com/ipfs/aegir/blob/15f01ea4f27738a9483a464552286e0739d797b1/src/check-project/readme/header.js#L36

achingbrain · 2023-04-05T07:12:30Z

packages/interop/README.md

@@ -4,7 +4,7 @@
  </a>
 </p>

-# @helia/interop <!-- omit in toc -->
+# [@helia/interop](https://github.com/ipfs/helia/tree/main/packages/interop) <!-- omit in toc -->


https://github.com/ipfs/aegir/blob/15f01ea4f27738a9483a464552286e0739d797b1/src/check-project/readme/header.js#L36

achingbrain · 2023-04-05T07:12:39Z

packages/interface/README.md

+- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/interface/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/interface/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)


Please PR: https://github.com/ipfs/aegir/blob/15f01ea4f27738a9483a464552286e0739d797b1/src/check-project/readme/license.js#L30-L31

achingbrain · 2023-04-05T07:12:43Z

packages/interop/README.md

+- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/interop/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/interop/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)


Please PR: https://github.com/ipfs/aegir/blob/15f01ea4f27738a9483a464552286e0739d797b1/src/check-project/readme/license.js#L30-L31

whizzzkid · 2023-04-06T07:03:35Z

PR'd ipfs/aegir#1228

Brought in from: #77

whizzzkid added 3 commits April 4, 2023 21:51

docs(docs): 📝 Fixing backlinks

c4a8e20

docs(docs): 📝 Fixing license links

faa3fa7

docs(docs): 📝 Adding helia demo day video playlists

2d57938

whizzzkid requested review from achingbrain and SgtPooki April 5, 2023 04:30

whizzzkid changed the title ~~docs(docs): 📝 Fixing backlinks~~ docs(docs): 📝 Fixing Docs Apr 5, 2023

whizzzkid marked this pull request as ready for review April 5, 2023 04:30

whizzzkid mentioned this pull request Apr 5, 2023

2023/2024 Contributor Hospitality Ideas #35

Open

24 tasks

achingbrain requested changes Apr 5, 2023

View reviewed changes

achingbrain changed the title ~~docs(docs): 📝 Fixing Docs~~ docs: Fixing Docs Apr 5, 2023

achingbrain changed the title ~~docs: Fixing Docs~~ docs: Fixes Docs Apr 5, 2023

achingbrain changed the title ~~docs: Fixes Docs~~ docs: Fixes docs Apr 5, 2023

whizzzkid mentioned this pull request Apr 6, 2023

fix(readme): Fixing Links ipfs/aegir#1228

Closed

whizzzkid closed this Apr 6, 2023

whizzzkid mentioned this pull request Apr 6, 2023

docs: added link to helia demos #80

Merged

achingbrain pushed a commit that referenced this pull request Apr 6, 2023

docs: added link to helia demos (#80)

fb8fcde

Brought in from: #77

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Fixes docs #77

docs: Fixes docs #77

whizzzkid commented Apr 5, 2023 •

edited

Loading

achingbrain left a comment

achingbrain Apr 5, 2023

achingbrain Apr 5, 2023

achingbrain Apr 5, 2023

achingbrain Apr 5, 2023

achingbrain Apr 5, 2023

achingbrain Apr 5, 2023

whizzzkid commented Apr 6, 2023

		- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/helia/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
		- MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/helia/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

docs: Fixes docs #77

docs: Fixes docs #77

Conversation

whizzzkid commented Apr 5, 2023 • edited Loading

achingbrain left a comment

Choose a reason for hiding this comment

achingbrain Apr 5, 2023

Choose a reason for hiding this comment

achingbrain Apr 5, 2023

Choose a reason for hiding this comment

achingbrain Apr 5, 2023

Choose a reason for hiding this comment

achingbrain Apr 5, 2023

Choose a reason for hiding this comment

achingbrain Apr 5, 2023

Choose a reason for hiding this comment

achingbrain Apr 5, 2023

Choose a reason for hiding this comment

whizzzkid commented Apr 6, 2023

whizzzkid commented Apr 5, 2023 •

edited

Loading