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

chore: Upgrade docusaurus to 3.4.0 + new patch #3129

Merged
merged 8 commits into from
Jul 19, 2024

Conversation

eonarheim
Copy link
Member

@eonarheim eonarheim commented Jul 19, 2024

===:clipboard: PR Checklist :clipboard:===

  • 📌 issue exists in github for these changes
  • 🔬 existing tests still pass
  • 🙈 code conforms to the style guide
  • 📐 new tests written and passing / old tests updated with new scenario(s)
  • 📄 changelog entry added (or not needed)

==================

Closes #

Changes:

  • Upgrade to Docusaurus 3.4.0

Copy link

cloudflare-workers-and-pages bot commented Jul 19, 2024

Deploying excaliburjs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9d974c8
Status: ✅  Deploy successful!
Preview URL: https://eca83f34.excaliburjs.pages.dev
Branch Preview URL: https://chore-upgrade-docusaurus-doc.excaliburjs.pages.dev

View logs

@github-actions github-actions bot added the chore Maintenance tasks, like upgrading libraries or release tasks label Jul 19, 2024
@kamranayub
Copy link
Member

Getting a webpack config error when I pull this down and run npm install and npm start 🤔

@kamranayub
Copy link
Member

Looks like invalid configuration being passed:

[ERROR] ValidationError: Invalid configuration object. Webpack has been 
initialized using a configuration object that does not match the API 
schema.
 - configuration[1] should be an object:
   object { amd?, bail?, cache?, context?, dependencies?, devServer?, 
devtool?, entry?, experiments?, extends?, externals?, externalsPresets?, 
externalsType?, ignoreWarnings?, infrastructureLogging?, loader?, mode?, 
module?, name?, node?, optimization?, output?, parallelism?, 
performance?, plugins?, profile?, recordsInputPath?, recordsOutputPath?, 
recordsPath?, resolve?, resolveLoader?, snapshot?, stats?, target?, 
watch?, watchOptions? }
   -> Options object as provided by the user.
    at validate (E:\Development\Contrib\excaliburjs\Excalibur\site\node_mo
dules\webpack\node_modules\schema-utils\dist\validate.js:191:11)
    at validateSchema (E:\Development\Contrib\excaliburjs\Excalibur\site\n
ode_modules\webpack\lib\validateSchema.js:78:2)
    at create (E:\Development\Contrib\excaliburjs\Excalibur\site\node_modu
les\webpack\lib\webpack.js:119:24)
    at webpack (E:\Development\Contrib\excaliburjs\Excalibur\site\node_mod
ules\webpack\lib\webpack.js:167:32)
    at f (E:\Development\Contrib\excaliburjs\Excalibur\site\node_modules\w
ebpack\lib\index.js:72:16)
    at createWebpackDevServer (E:\Development\Contrib\excaliburjs\Excalibu
r\site\node_modules\@docusaurus\core\lib\commands\start\webpack.js:121:44)
    at async Command.start (E:\Development\Contrib\excaliburjs\Excalibur\s
ite\node_modules\@docusaurus\core\lib\commands\start\start.js:31:23) {
  errors: [
    {
      keyword: 'type',
      dataPath: '[1]',
      schemaPath: '#/type',
      params: { type: 'object' },
      message: 'should be object',
      schema: 'object',
      ```

@kamranayub
Copy link
Member

One thing I noticed which in the future would be nice is to hot reload API docs when ex src files change. It does re-compile ex but that's for code samples.

@kamranayub
Copy link
Member

kamranayub commented Jul 19, 2024

I added a test @apilink to show that we can link between API pages. Note that I originally tried the "official" TypeDoc @link way but that isn't quite supported the same way:

milesj/docusaurus-plugin-typedoc-api#66 (comment)

@kamranayub kamranayub added the docs Relating to documentation in any way label Jul 19, 2024
@kamranayub kamranayub self-requested a review July 19, 2024 16:15
Copy link
Member

@kamranayub kamranayub left a comment

Choose a reason for hiding this comment

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

It works locally!

@eonarheim eonarheim merged commit ef8686e into main Jul 19, 2024
8 checks passed
@eonarheim eonarheim deleted the chore/upgrade-docusaurus+docs branch July 19, 2024 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Maintenance tasks, like upgrading libraries or release tasks docs Relating to documentation in any way
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants