Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Fix Broken Links in packages' READMEs #1880

Closed
maschad opened this issue Jul 18, 2023 · 2 comments
Closed

Docs: Fix Broken Links in packages' READMEs #1880

maschad opened this issue Jul 18, 2023 · 2 comments
Labels
good first issue Good issue for new contributors help wanted Seeking public contribution on this issue need/triage Needs initial labeling and prioritization topic/docs Documentation

Comments

@maschad
Copy link
Member

maschad commented Jul 18, 2023

Some of the modules have broken links such as https://github.com/libp2p/js-libp2p/tree/master/packages/interface?rgh-link-date=2023-07-18T17%3A39%3A41Z#api-docs amongst others that need to be updated.

See #1777 (comment)
@maschad maschad added need/triage Needs initial labeling and prioritization help wanted Seeking public contribution on this issue good first issue Good issue for new contributors labels Jul 18, 2023
@maschad maschad mentioned this issue Jul 18, 2023
Closed
@maschad maschad added the topic/docs Documentation label Jul 18, 2023
@maschad
Copy link
Member Author

maschad commented Jul 18, 2023

cc @DougAnderson444

@maschad maschad changed the title Docs: Fix Broken Links in READMEs Docs: Fix Broken Links in packages' READMEs Jul 18, 2023
@maschad
Copy link
Member Author

maschad commented Jul 25, 2023

These docs will be published in 0.46 and also we are exploring more UI friendly generated API docs in Markdown here

@maschad maschad closed this as completed Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good issue for new contributors help wanted Seeking public contribution on this issue need/triage Needs initial labeling and prioritization topic/docs Documentation
Projects
js-libp2p
Archived in project
Milestone
No milestone
Development

No branches or pull requests
1 participant
@maschad