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.

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

Update jsdoc to use full URLs instead of non-prefix absolute urls (also fix some urls) #13328

Merged
merged 11 commits into from Apr 25, 2023

Conversation

hasezoey
Copy link
Collaborator

Summary

This PR updates the jsdoc to use full paths (https://mongoosejs.com/path/to/somewhere.html) instead of /path/to/somewhere.html, this way the URLs also work in editors and are arguably easier to add / maintain, also updates urls from #type_Type-method to #Type(.prototype).method.

  • update some wrong urls which had //
  • fix blc broken links
  • include MongooseArray in documentation output
  • update eslintrc to ignore versioned documentation too
  • update scripts/website.js to process https://mongoosejs.com/ links to local links and versioned links (if versioning is activated)
  • update lib/ file's jsdoc to use the full qualified url
  • update lib/ file's jsdoc to use the new header-ids

PS: some links in schematype.html are currently not valid, but #13310 already fixes that

@hasezoey hasezoey added the docs This issue is due to a mistake or omission in the mongoosejs.com documentation label Apr 25, 2023
Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@vkarpov15 vkarpov15 added this to the 7.1.0 milestone Apr 25, 2023
@vkarpov15
Copy link
Collaborator

Just need to resolve merge conflicts

@vkarpov15 vkarpov15 merged commit d6a7611 into Automattic:master Apr 25, 2023
19 checks passed
@hasezoey hasezoey deleted the fullURLs branch April 25, 2023 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is due to a mistake or omission in the mongoosejs.com documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants