Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.11%. Comparing base (5d55838) to head (27b7b9f).
Report is 1 commits behind head on master.

@@           Coverage Diff           @@
##           master    #8194   +/-   ##
=======================================
  Coverage   99.11%   99.11%           
=======================================
  Files         141      141           
  Lines        4076     4076           
=======================================
  Hits         4040     4040           
  Misses         36       36           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mgrunberg yes but only with a repository link to the docs folder on the 3-0-stable branch. Vitepress doesn't support documentation versioning. We could probably move the v3 docs into a subfolder and then use the multiple sidebars feature which is path based alongside a nav option to select the current or v3 docs.

@mgrunberg I extracted the general updates that were version independent #8424 and merged that in. Let me know if you are still interested in trying something out for docs versioning or to first share an approach to see if it's something we'll consider. Thanks!

@mgrunberg I extracted the general updates that were version independent #8424 and merged that in. Let me know if you are still interested in trying something out for docs versioning or to first share an approach to see if it's something we'll consider. Thanks!

I'm still interested in this. I'm still figuring out how to do this but here is what I have in mind.

use the multiple sidebars feature which is path based alongside a nav option to select the current or v3 docs.

I want to achieve something like that.

What I have in mind is:

1. Keep v3 doc in 3-0-stable branch
2. Fetch docs during doc-build process

Why fetching during build? I don't want to carry over old doc files in master. If old docs need an update (backport of a feature?), it make more sense to do the PR in that version branch.
I understand that we still gonna need to trigger a workflow in master to deploy the docs. It's a downside but nothing too bad in my opinion.

I haven't thought a lot on how to fetch. Could be a node fetch, a git export, a git submodule. There are ways for sure.

Following this idea, I'm wondering if the first step should be migrate current doc (v3) to vite-press. I don't know if there is a blocker for that.

Anyway, that's on my head. What do you think.

Oh, before I forget. I won't be able to work on this until Friday.

I think that may be too much or too problematic since the v3 docs have to map to the expected pages which would change in the new setup. I don't mind duplicating the v3 docs on master branch since we need to build a single site and deploy it. I believe it would be easier to include the v3 docs in the new Vitepress setup. We'd have to do some formatting updates (e.g. fix headings) in some cases anyway. You are welcome to try either approach but figure just easiest to work with duplicate v3 docs in master. No rush on this. Thanks for expressing an interest in tackling it!

@mgrunberg I've updated this PR so it just migrates the existing docs content to VitePress. The v4 docs changes I'll have in a new branch. We can figure out there how to incorporate both v3 and v4 docs in the VitePress site. At least this way we can migrate the docs to VitePress and hopefully others will want to make documentation updates. Let me know what you think.

@mgrunberg I've updated this PR so it just migrates the existing docs content to VitePress. The v4 docs changes I'll have in a new branch. We can figure out there how to incorporate both v3 and v4 docs in the VitePress site. At least this way we can migrate the docs to VitePress and hopefully others will want to make documentation updates. Let me know what you think.

@javierjulio The new docs look amazing! I left a few comments but the PR looks really good