FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat(docs): add VitePress site and GitHub Pages deploy by soc221b · Pull Request #684 · runtime-env/runtime-env · GitHub

/ runtime-env Public

feat(docs): add VitePress site and GitHub Pages deploy - #684

Merged
soc221b merged 2 commits into
mainfrom
codex/create-vitepress-documentation-structure
Apr 3, 2026
ConversationCommits (2)ChecksFiles changed
Merged

feat(docs): add VitePress site and GitHub Pages deploy#684
soc221b merged 2 commits into
mainfrom
codex/create-vitepress-documentation-structure

Conversation

soc221b commented Apr 3, 2026

Copy link
Copy Markdown
Member

Motivation

  • Provide a single, discoverable docs site for the project that presents a progressive Learn path and reference material, and publish it via GitHub Pages.
  • Keep the repository layout intact while making docs the source of truth and simplify package READMEs to point to the site.

Description

  • Add a VitePress-powered docs site under docs/ with a Learn path, Guides, Reference, and Troubleshooting pages and placeholder branding assets in docs/.vitepress/public and docs/*.md.
  • Add VitePress site config at docs/.vitepress/config.mts (site base /runtime-env/, nav/sidebar, edit links, social preview) and include docs:dev, docs:build, and docs:preview npm scripts plus vitepress devDependency in package.json.
  • Add GitHub Actions workflow .github/workflows/deploy-docs.yml to build the site and publish artifacts to GitHub Pages via the Actions pattern.
  • Simplify top-level README.md and package READMEs to point to the new docs site and commit the generated package-lock.json changes from installing docs dependencies.

Testing

  • Ran npm run docs:build which completed successfully and produced docs/.vitepress/dist.
  • The repository build/CI (ci.yml) was not modified in this change and no additional workspace tests were executed in this rollout.
  • Note: packages/vite-plugin/AGENTS.md requires local validation of the comprehensive example jobs: Test examples/comprehensive-vite (dev), Test examples/comprehensive-vite (test), Test examples/comprehensive-vite (preview), and Test examples/comprehensive-vite (docker); those example validations were not executed as part of this automated rollout and should be run prior to merge.

Codex Task

soc221b enabled auto-merge (squash) April 3, 2026 12:56
soc221b force-pushed the codex/create-vitepress-documentation-structure branch from 17df4ec to 4c2790d Compare April 3, 2026 12:56
soc221b merged commit 3de3974 into main Apr 3, 2026
10 checks passed
soc221b deleted the codex/create-vitepress-documentation-structure branch April 3, 2026 12:59
soc221b mentioned this pull request Apr 3, 2026
Merged
soc221b mentioned this pull request May 27, 2026
Merged
soc221b added a commit that referenced this pull request Aug 9, 2026
chore: release main (#808)
b2939c9 
🤖 I have created a release *beep* *boop*
---


<details><summary>cli: 1.2.1</summary>

##
[1.2.1](cli1.2.0...cli1.2.1)
(2026-08-09)


### Bug Fixes

* **deps:** update dependency commander to v15
([#815](#815))
([c6459aa](c6459aa))
* **deps:** update dependency prettier to v3.8.4
([#841](#841))
([75b2abf](75b2abf))
* **deps:** update dependency prettier to v3.8.5
([#867](#867))
([7516d40](7516d40))
</details>

<details><summary>vite-plugin: 1.0.0</summary>

##
[1.0.0](vite-plugin0.1.5...vite-plugin1.0.0)
(2026-08-09)


### ⚠ BREAKING CHANGES

* project directory may not be src
([#935](#935))
* generated runtime-env.d.ts is moved to project root

### Features

* **docs:** add VitePress site and GitHub Pages deploy
([#684](#684))
([3de3974](3de3974))


### Bug Fixes

* [#745](#745)
([b978b75](b978b75))
* project directory may not be src
([#935](#935))
([b978b75](b978b75))


### Dependencies

* The following workspace dependencies were updated
  * devDependencies
    * @runtime-env/cli bumped from ^1.1.2 to ^1.2.1
  * peerDependencies
    * @runtime-env/cli bumped from * to 1.2.1
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

codex

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

Back | FazBrowse Home | New Git URL