docs: move docs to main branch #969

[1e9y]

Moving documentation from the gh-pages branch to main branch to keep it closer to the sources. What I have done in this PR:

• Amended docs workflow to trigger on new release event.
• Moved Vitepress configuration from branch (root) to main (docs folder)
• Added relevant package.json commands
• Moved all doc sources to main

Fixes #969

• Tests pass
• Appropriate changes to README are included in PR

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[1e9y]

@antonmedv Can you please confirm that this solution aligns with your idea?

[antongolub]

This does mean, that <root>/docs/docs will be created, while Upload artifact step is still referencing to <root>/docs

[antonmedv]

Lets rename it to build?

[1e9y]

Good point, @antongolub. I renamed the artifact directory to build, as @antonmedv suggested, and amended workflow file and Vitepress configuration accordingly.

[antongolub]

@1e9y

https://github.com/google/zx/actions/runs/12357969325/job/34491188714?pr=985
No idea what exactly is broken, but my first steps for similar cases: rm -rf node_modules package-lock.json && npm i
And rebase plz.

[1e9y]

@antongolub

My latest commit has a green tick. But it didn't run the workflow for some reason... I guess one of you must approve it.

[antongolub]

Seems good.

[antongolub]

@1e9y ,
Thanks for the contribution. Now you're able to update your gh profile badges to get the reward.