-
-
Notifications
You must be signed in to change notification settings - Fork 920
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
chore(deps): update doc-dependencies #2301
Conversation
I created this PR to ensure the rc versions don't break anything for us. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #2301 +/- ##
==========================================
- Coverage 99.57% 99.57% -0.01%
==========================================
Files 2807 2807
Lines 250379 250379
Branches 1139 1140 +1
==========================================
- Hits 249308 249306 -2
- Misses 1043 1045 +2
Partials 28 28 |
It does 😢 .
Any suggestions? |
588689e
to
45bfbfc
Compare
9799281
to
30d73ea
Compare
24e1098
to
680c62f
Compare
361dd02
to
7968dcd
Compare
Should we merge this now instead of waiting for v9? |
I'm biased, so others should "vote". 👍 = Merge now; 👎 = Wait for v9 |
Isnt that the whole point/idea behind voting aka expressing your preference for one of the options?! |
yes and no, just because I would like to force something doesn't mean that it is actually good for the community or maybe, now I'm reading my quoted post in your answer: I did not wrote "I'm biased" alone 🤔 |
Anyway, I would like to merge this in the hope that this fixes the issues blocking #2513 |
While working together on #2513 (comment) we now definitely found out that #2301 does not affect the algolia search index in any way. Anyway, I also would like to get this PR merged to get it from the table :D |
Is this PR in the incorrect milestone? Currently it's in v9.0 but was released in v8.4.0. There were no breaking changes, so why was this targeted for v9? |
GitHub PRs do have a history that can be read So on #2301 (comment) it was set for v9 or later, I assume due to priority or whatever |
Doesn't cost anything to think that in your head and not write it (and with that not look like an asshole) 🤷 thats all I'm gonna say to that! I did in fact read the history, and was not able to get why things where done, SUre there was a vote, but why was there suddenly the possibility to merge this? This PR was open for 5 months. It even had the "DO NOT MERGE" label after changes were done that removed, what looked like the breaking changes. Sorry for double checking if we accidently shiped breaking features. Will not happen again. |
You took it way to drastically 🫠 This was only something affecting the docs |
The main reason why i put this on hold were the cjs/esm issues that I couldnt fix and though were related to us being cjs-ish and vitepress switching to esm. Thus requiring us to switch to esm, thus being slated for v9.0. |
This PR contains the following updates:
~4.19.1
->~4.20.0
~0.24.8
->~0.25.3
1.0.0-beta.7
->1.0.0-rc.25
Release Notes
algolia/algoliasearch-client-javascript (@algolia/client-search)
v4.20.0
Compare Source
TypeStrong/TypeDoc (typedoc)
v0.25.3
Compare Source
Features
--sourceLinkExternal
option to render source code links as external, #2415.declarationMap
option to be set to true to handle cross-package links in packages mode, #2416.external-last
option for the--sort
option, #2418.Bug Fixes
Thanks!
v0.25.2
Compare Source
Features
navigationLeaves
option to remove branches from the navigation tree, #2382.sortEntryPoints
option (defaults to true) to allow disabling entry point sorting, #2393.Bug Fixes
@template
constraints on JSDoc defined type parameters, #2389.declare module "foo"
, #2401.Thanks!
v0.25.1
Compare Source
Features
stripYamlFrontmatter
config option to remove YAML frontmatter from README.md, #2381.--excludeCategories
config option to remove reflections present in any excluded category, #1407.with large projects and also provides large space benefits. Themes may now override
DefaultTheme.buildNavigation
to customize the displayed navigation tree, #2287.
Note: This change renders
navigation.fullTree
obsolete. If you set it, TypeDoc will warn that it is being ignored.It will be removed in v0.26.
DefaultThemeRenderContext.icons
is overwritten by a custom theme.Note: To perform this optimization, TypeDoc relies on
DefaultThemeRenderContext.iconCache
being rendered withineach page. TypeDoc does it in the
defaultLayout
template.Bug Fixes
@property
now works as expected if used to override a method's documentation.--watch
mode works again, #2378.intrinsic
keyword if TS intrinsic types are included in documentation.--exclude
is now respected when expanding globs in entry points, #2376.Thanks!
v0.25.0
Compare Source
Breaking Changes
legacy-packages
option for--entryPointStrategy
.--categorizeByGroup
tofalse
.gitRemote
is no longer supported.Application
instance must now be retrieved viaApplication.bootstrap
orApplication.bootstrapWithPlugins
, #2268.ReflectionKind.ObjectLiteral
that was never used by TypeDoc.DefaultThemeRenderContext.comment
andDefaultThemeRenderContext.attemptExternalResolution
.Features
--preserveLinkText
option (defaults to true) which determines whether the reflection name or full link text is includedin the output when no override is specified, #2355.
site from ~5.6 seconds to ~5.4 seconds.
--disableGit
option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326.@showGroups
,@hideGroups
,@showCategories
,@hideCategories
to configure the navigation pane on aper-reflection basis, #2329.
--jsDocCompatibility.defaultTags
set,@defaultValue
is now implicitly a code block if the text contains no code, #2370.Bug Fixes
Foo#bar
) links were used and--useTsLinkResolution
is enabled in some cases, #2360.@inheritDoc
was not properly resolved across packages in packages mode, #2331.@interface
use on union types, #2352.Theme.getUrls
, #2318.@namespace
is used on a variable with an associated namespace, #2364.@namespace
property discovery if merged with a type and the type was declared first #2364.reflection.sources
now considers the node's name like non-signature location discovery does.Thanks!
v0.24.8 (2023-06-04)
Features
navigation.fullTree
to control rendering the full navigation tree on each page, #2287.This option will likely be replaced in 0.25 with dynamic loading of the full tree.
--pretty
option now also controls whether generated HTML contains line breaks, #2287.MarkdownEvent.INCLUDE
for plugins, #2284.Bug Fixes
and any other block tags in the order they are defined in the comment, #2285.
Thanks!
v0.24.7 (2023-05-08)
Features
Bug Fixes
sort
option, #2272.v0.24.6 (2023-04-24)
Features
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259.jsDocCompatibility
option withinheritDocTag
to ignore fully lowercaseinheritDoc
tags andignoreUnescapedBraces
to disable warnings about unescaped{
and}
characters in comments.Bug Fixes
--useTsLinkResolution
is no longer ignored within block tags, #2260.Thanks!
v0.24.5 (2023-04-22)
Features
--navigation.includeCategories
and
--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option alsoeffects this behavior. If
categorizeByGroup
is set (the default) andnavigation.includeGroups
isnot set, the value of
navigation.includeCategories
will be effectively ignored since categorieswill be created only within groups, #1532.
@returns
blocks will now be rendered with the return type, #2180.--groupOrder
option to specify the sort order of groups, #2251.Bug Fixes
--hideParameterTypesInTitle
option, #2226.@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.Thanks!
v0.24.4 (2023-04-16)
Bug Fixes
v0.24.3 (2023-04-16)
Bug Fixes
v0.24.2 (2023-04-15)
Features
Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
complicated signatures as such, TypeDoc now only renders parameter names in the signature title
and includes the type in the parameter details as usual. This can be controlled with the new
--hideParameterTypesInTitle
option.Bug Fixes
&
showing as&
and HTML text showing up in page contents navigation, #2224.source-order
sort strategy failing to compare reflections within a file.enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, #2237.__@​
symbol name, #2234.--entryPointStrategy packages
.Thanks!
v0.24.1 (2023-04-09)
Bug Fixes
@example
tags, #2222.vuejs/vitepress (vitepress)
v1.0.0-rc.25
Compare Source
Bug Fixes
Features
mergeConfig()
(#3143) (a850786)Performance Improvements
v1.0.0-rc.24
Compare Source
Bug Fixes
Features
v1.0.0-rc.23
Compare Source
Bug Fixes
v1.0.0-rc.22
Compare Source
Bug Fixes
v1.0.0-rc.21
Compare Source
Bug Fixes
Features
v1.0.0-rc.20
Compare Source
Bug Fixes
v1.0.0-rc.19
Compare Source
v1.0.0-rc.18
Compare Source
v1.0.0-rc.17
Compare Source
v1.0.0-rc.16
Compare Source
v1.0.0-rc.15
Compare Source
Bug Fixes
Features
createContentLoader
(4f9a60b), closes #2985v1.0.0-rc.14
Compare Source
Bug Fixes
Features
v1.0.0-rc.13
Compare Source
Bug Fixes
Features
Reverts
v1.0.0-rc.12
Compare Source
Bug Fixes
Features
v1.0.0-rc.11
Compare Source
Bug Fixes
Features
v1.0.0-rc.10
Compare Source
Bug Fixes
Features
Reverts
base
" (#2865) (6be5a7e)v1.0.0-rc.9
Compare Source
Bug Fixes
art
dir (1f8c58a)Features
toggle-appearance
function (#2844) (a5f2eac)BREAKING CHANGES
pathname://
protocol is dropped. Specifytarget="_self"
ortarget="_blank"
instead. Refer docs to learn more.github-light
andgithub-dark
. If you want to use the old theme, you can setmarkdown.theme
in your config to'material-theme-palenight'
.isDark
is changed to use vueuse. It might impact your custom theme. You can customize its behavior usingappearance
option.v1.0.0-rc.8
Compare Source
v1.0.0-rc.7
Compare Source
v1.0.0-rc.6
Compare Source
v1.0.0-rc.5
Compare Source
v1.0.0-rc.4
Compare Source
Bug Fixes
createContentLoader
generates invalid url whenbase
is set (#2714) (0f38eb4)"type": "module"
is not present (23d7511)Features
markdown.preConfig
option (ce85726), closes #1382Reverts
BREAKING CHANGES
v1.0.0-rc.3
Compare Source
v1.0.0-rc.2
Compare Source
v1.0.0-rc.1
Bug Fixes
Features
Configuration
📅 Schedule: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.