search

libp2p / js-libp2p

The JavaScript Implementation of libp2p networking stack.
https://libp2p.io
Other
2.31k stars 442 forks source link

30+ Broken links in readme. #2423

Closed MichaelJCole closed 5 months ago

MichaelJCole commented 7 months ago

Severity:

High?

Description:

Hi, thanks for this visionary project. I noticed some links in the readme are broken.

See broken links in the attached file: libp2p.github.io.csv libp2p.github.io.html.zip

Steps to reproduce the error:

docker run --rm dcycle/broken-link-checker:3 -r 1 https://libp2p.github.io/js-libp2p/index.html  > ~/Desktop/libp2p.github.io.csv
achingbrain commented 7 months ago

Thanks for opening this - would you like to open a PR that updates the links to point to the new locations?

MichaelJCole commented 7 months ago

Hi @achingbrain thank you responding. How could I know how to do that?

I really have no idea how your project is structured or should be documented or how it works. How could I know how it should work enough to document it?

I wasted a bunch of time trying to customize Kubo only to realize it has 47 repos and doesn't make any sense. I'm realizing libp2p and helia have the same problem.

I've been filing bugs on js-store (https://github.com/ipfs/js-stores/issues/300 and https://github.com/ipfs/js-stores/issues/299). I finally worked that out, but I burned a bunch of time on it. I ran into problems with simple-metrics and didn't file issues. I'm not sure what is supposed to work and what is abandoned. I can do drive-by contributions improving something that already exists. I can make PR's if I know how it's supposed to work.

If yall are serious about inviting contributions, start with a README and documentation - I added the link checker so it should be a few minutes of work for someone who wrote it. Otherwise, it just seems like a lazy request to spend hours cleaning up someone else's unfinished work. I can't do that, I have to create value for my users.

There's alot of opportunity and value in what's already here - it just needs to be brought over the finish line.

SgtPooki commented 6 months ago

I ran the docker broken link checker and checked into GETTING_STARTED.md broken link. it looks like packages/libp2p/README.md is linking to ./doc/GETTING_STARTED.md which exists on the root.

@achingbrain I think some of the doc building in aegir isn't handling links to github docs properly. Also, looking at the output of .docs after building locally, it doesn't seem to contain any markdown files:

╰─ ✔ ❯ ls .docs
assets         classes        enums          functions      hierarchy.html index.html     interfaces     modules        types          variables

╰─ ✔ ❯ ls .docs/**/*.md
zsh: no matches found: .docs/**/*.md

@MichaelJCole for now, you should probably use links from the github README root cause those will resolve properly.