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

Docs with incorrect links #4002

Closed
Winterhuman opened this issue Jan 2, 2022 · 2 comments · Fixed by #4043
Closed

Docs with incorrect links #4002

Winterhuman opened this issue Jan 2, 2022 · 2 comments · Fixed by #4043
Labels
need/triage Needs initial labeling and prioritization

Comments

@Winterhuman
Copy link

Winterhuman commented Jan 2, 2022

Version:
N/A

Platform:
N/A

Subsystem:
N/A

Severity:

Very Low - Translation or documentation mistake. Something that won't give anyone a bad day.

Description:

The BROWSERS.md doc links to a non-existent doc which causes an error from GitHub, more specifically it's the preload link within the phrase "Preload content on the fly using preload feature", the link should be:

https://github.com/ipfs/js-ipfs/blob/master/docs/MODULE.md#optionspreload

But, it's currently:

https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/docs/MODULE.md#optionspreload

Also, DELEGATE_ROUTERS.md links to itself when trying to specify the libp2p option, it's should be:

https://github.com/ipfs/js-ipfs/blob/master/docs/MODULE.md#optionslibp2p

But, it's currently:

https://github.com/ipfs/js-ipfs/blob/master/docs/DELEGATE_ROUTERS.md#optionslibp2p

@Winterhuman Winterhuman added the need/triage Needs initial labeling and prioritization label Jan 2, 2022
@welcome
Copy link

welcome bot commented Jan 2, 2022

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additional round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment.
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

@Winterhuman Winterhuman changed the title BROWSERS.md has link to non-existent doc Docs with incorrect links Jan 2, 2022
@lidel
Copy link
Member

lidel commented Feb 4, 2022

Thank you @LynHyper ! I fixed them in #4043.
In the future do not hesitate and open a PR yourself (same amount of work as describing what needs to be fixed)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
need/triage Needs initial labeling and prioritization
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants