Repository navigation
Roll up Renovate updates, convert config to TypeScript, and tidy Docusaurus config - #540
Merged
Merged
Conversation
✅ Deploy Preview for vc-community-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Linked Issue
Rolls up everything "awaiting schedule" on the Renovate Dependency Dashboard (#535). The dashboard issue is permanent and stays open.
Description
Dependency updates, one commit each:
core,preset-classic,module-type-aliases,types)onBrokenMarkdownLinkstomarkdown.hooks.onBrokenMarkdownLinks. The top-level option has been deprecated since 3.9 and the build warned about it.react/react-dom→ 19.3.0,@mdx-js/react→ 3.1.1prettier2 → 3, then a separate reformat commit touching two files: trailing commas in.markdownlint-cli2.jsoncand trailing whitespace in one speaker-info doccaniuse-litewarning.TypeScript conversion:
docusaurus.config.js→docusaurus.config.ts, typed withConfigandsatisfies Preset.Options/Preset.ThemeConfigsidebars.js→sidebars.ts, typed withSidebarsConfig. Both files were renamed withgit mvso history follows them.tsconfig.jsonthat extends@docusaurus/tsconfig, plus three devDeps:typescript7,@docusaurus/tsconfigand@docusaurus/plugin-content-docs(pnpm needs the last one for the sidebar type)tsconfig.jsonsetsbaseUrltonulland restatespaths, because TypeScript 7 removedbaseUrlbut@docusaurus/tsconfigstill sets itpnpm typecheckscript and CI step.greptilerules and file pointers now reference the.tsfilesDocusaurus config review, one commit each:
The site
urlis nowhttps://docs.virtualcoffee.io, so canonical links, the sitemap and social preview images use the custom domain. The README link is updated too.vc-community-docs.netlify.appkeeps serving the site as a fallback; its canonical tags point search engines to the custom domain.Removed the GitHub Pages leftovers (
organizationName,projectName, thedeployscript) and the template boilerplate comments. The site deploys from Netlify.Set
blog: falseandpages: false, since there is no blog and nosrc/pageseditUrlis now a plain string. The generated edit links are unchanged.onBrokenMarkdownLinksis now'throw', so a broken.mdlink fails CI. No existing links broke. Broken anchors still only warn.The navbar logo now links to the docs home page instead of
virtualcoffee.io/docsShortened the navbar title to "VC Community Docs" and the link to "Contributing" to make room for the search box. Without this, the title was cut off on phones and the link wrapped at narrower desktop widths. The page
<title>keeps the full name.Renamed the sidebar id from
sidebarPathtodocsAdded the Creative Community challenge to the Monthly Challenges sidebar. It was left out in the Docusaurus migration.
Docs now show "Last updated on … by …". CI checks out the full git history (
fetch-depth: 0) so those dates are correct.Added local search with
@easyops-cn/docusaurus-search-local. The index is built at build time and needs no external account.Marked 28 docs that aren't in the sidebar as
unlisted: true: archives, VCHI, topic lists and vc-conference. Their URLs keep working, but they are nownoindexand left out of the sitemap. Docusaurus shows an "Unlisted page" banner on them.Package cleanup:
namefield inpackage.jsonclsxwas left over from the template, sincesrc/has no components.@docusaurus/module-type-aliasesis redundant becausetheme-classicandplugin-content-docsalready depend on it. Both should come back if custom React components are added.I left the
future.v4flags off on purpose. In 3.10 they turn off MDX1 compat, which breaks the 7 docs that use HTML comments, includingmarkdownlint-disabledirectives.Methodology
This is one PR instead of five Renovate PRs, so the site is built and checked once with everything updated together. Commits stay atomic so any single change can be reverted on its own.
Verified locally:
pnpm install --frozen-lockfile,pnpm check,pnpm lint:md,pnpm typecheckandpnpm buildall pass with no warningstscrejected an invalid sidebar item, which confirms the typecheck catches real mistakesFor the config changes, I checked the build output:
noindexand are missing fromsitemap.xmlI spot-checked the deploy preview against prod on 6 pages: the home page, the book clubs guide, room leaders, the 2021 MC script, Preptember and VCHI roles. The article text is identical; the only addition is the "Last updated" line.
The deploy preview shows real git dates, so Netlify has the full history. Pages this PR changed only mechanically (the unlisted front matter and the Prettier reformat) will show today's date until they're next edited.
Also checked:
/docs/*URLs still redirectCode of Conduct