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

docs: Update TypeDoc plugins and tweak config #7653

Merged

Conversation

tgreyuk
Copy link
Contributor

@tgreyuk tgreyuk commented May 26, 2023

☕️ Reasoning

This PR includes updates to package versions for TypeDoc and associated plugins. It includes updated pnpm-lock.yaml file but not sure if the diffs look correct.

Updated config options

There have been some minor tweaks to the options in the last few versions. There have also been some tweaks to file structure, for example directories now contain number prefixes so typedoc sorting options are properly adhered to. https://docusaurus.io/docs/sidebar/autogenerated#using-number-prefixes . Also because of naming conflicts page names are now namespaced eg module.index to avoid index pages being overridden.

Exposing literals of intersection types

The updates include exposing literals of intersection types to the documentation:

Screenshot 2023-05-26 at 09 52 35

Cleanup navigation

In addition have filtered out the index pages from the sidebar to provide a cleaner navigation structure using sidebarItemsGenerator https://docusaurus.io/docs/sidebar/autogenerated#customize-the-sidebar-items-generator . This is not currently possible to do with adding metadata to pages with frontmatter although there are feature requests to do this. See facebook/docusaurus#5689.

Screenshot 2023-05-26 at 09 57 17

🧢 Checklist

  • [x ] Documentation
  • Tests
  • [x ] Ready to be merged

🎫 Affected issues

Please scout and link issues that might be solved by this PR.

Fixes: NA

📌 Resources

@vercel
Copy link

vercel bot commented May 26, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
auth-docs ⬜️ Ignored (Inspect) May 26, 2023 9:08am
next-auth-docs ⬜️ Ignored (Inspect) May 26, 2023 9:08am

@vercel
Copy link

vercel bot commented May 26, 2023

@tgreyuk is attempting to deploy a commit to the authjs Team on Vercel.

A member of the Team first needs to authorize it.

@socket-security
Copy link

New dependency changes detected. Learn more about Socket for GitHub ↗︎


👍 No new dependency issues detected in pull request

Bot Commands

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@* or ignore all packages with @SocketSecurity ignore-all

Pull request alert summary
Issue Status
Install scripts ✅ 0 issues
Native code ✅ 0 issues
Bin script shell injection ✅ 0 issues
Unresolved require ✅ 0 issues
Invalid package.json ✅ 0 issues
HTTP dependency ✅ 0 issues
Git dependency ✅ 0 issues
Potential typo squat ✅ 0 issues
Known Malware ✅ 0 issues
Telemetry ✅ 0 issues
Protestware/Troll package ✅ 0 issues

📊 Modified Dependency Overview:

⬆️ Updated Package Version Diff Added Capability Access +/- Transitive Count Publisher
typedoc@0.24.7 0.24.4...0.24.7 None +0/-0 typedoc-bot

@balazsorban44 balazsorban44 merged commit 62eb457 into nextauthjs:feat/nextjs-auth May 29, 2023
3 checks passed
@tgreyuk tgreyuk deleted the docs/update-typedoc-plugins branch May 30, 2023 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants