feat(docs): setup vitepress and github pages deployment

[allenhutchison]

Sets up VitePress for documentation and adds a GitHub Actions workflow to deploy to GitHub Pages.

Resolves #93

[gemini-code-assist]

Summary of Changes

Hello @allenhutchison, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a comprehensive documentation system using VitePress, complete with automated deployment to GitHub Pages. This initiative significantly enhances the project's ability to provide clear and accessible documentation, streamlining the process for both developers and users to understand and interact with the "Gemini Workspace Extension." It directly addresses and resolves issue #93.

Highlights

• Documentation Setup: Integrated VitePress to establish a dedicated documentation site for the project, providing a structured and modern platform for project information.
• Automated Deployment: Implemented a GitHub Actions workflow to automatically build and deploy the VitePress documentation to GitHub Pages, ensuring documentation is always up-to-date and accessible.
• Dependency and Script Updates: Updated package.json to include new npm scripts for documentation management (docs:dev, docs:build, docs:preview) and added vitepress and vue as development dependencies.

Ignored Files

• Ignored by pattern: .github/workflows/** (1)
  • .github/workflows/deploy-docs.yml

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces VitePress for documentation, including configuration, dependencies, and npm scripts. While this is a good start, there are two key issues. First, the VitePress configuration is missing the base property, which is essential for deploying to GitHub Pages; I've left a specific comment with a suggestion. Second, and more critically, the GitHub Actions workflow for deployment mentioned in the pull request title and description is missing from the changes. Without this workflow, the automated deployment to GitHub Pages will not be set up.