question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Consistenize Documentation links

See original GitHub issue

Prerequisites

  • I have written a descriptive issue title
  • I have searched existing issues to ensure the issue has not already been raised

Issue

(follow-up to #12582 and #12623)

Currently the Documentation links are all over the place, this is a tracker / reminder issue to fix this, currently the link types used are:

  • dot relative: ./api/somewhere
  • non-dot relative: api/somewhere
  • no-prefix absolute: /docs/api/somewhere (mostly fixed by #12623)
  • prefix absolute: https://mongoosejs.com/docs/api/somewhere

Note: the above names are not official ones, i just used what comes to mind for me

Anything that is absolute would not work well with versioning (as pointed out by the mentioned issue and PR) and not using a consistent style is not too easy to read.

I would also propose to add some note to CONTRIBUTING#documentation.

Also there would be the question of changing the API documentation (jsdoc) links to be consistent, but i am not sure on what we should change it to: relative or prefix-absolute, relative would work well with documentation and versioning, but would be hard to access through jsdoc (though this could be fixed by tsdoc in .d.ts) and could also be fixed by post-processing links in the api generation to be relative.

Issue Analytics

  • State:closed
  • Created a year ago
  • Reactions:3
  • Comments:6 (3 by maintainers)

github_iconTop GitHub Comments

2reactions
hasezoeycommented, Nov 8, 2022

Also, I ran the https://mongoosejs.com/ under a broken links checker:

may need to be re-run after #12623 and #12644

1reaction
hasezoeycommented, Nov 14, 2022

I guess the conclusion from #12623 is that the following link-style will be used: “no prefix relative paths”: guide.html instead of something like ./guide.html and only when a prefix is needed like ../ for ../guide.html from something like tutorials/index.html

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to use links in documentation - Contributor guide
This article provides guidance on creating links to other content on Microsoft Learn.
Read more >
Document.links - Web APIs - MDN Web Docs - Mozilla
The links read-only property of the Document interface returns a collection of all elements and elements in a document with a value for...
Read more >
Markdown links - Docusaurus
Markdown links. There are two ways of adding a link to another page: through a URL path and a file path. - [URL...
Read more >
Linking pages and files | Kentico 8 Documentation
Creating permanent links to documents (pages). If you need to create a permanent link to a document, use a URL in the following...
Read more >
Google Docs: Linking Within a Document - YouTube
You may already know that links can point to webpages, but in Google Docs they can also point to any part of the...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found