Skip to content

Add GitHub Pages deploy and site config#1

Merged
mohit-nagaraj merged 1 commit intomainfrom
dev
Feb 16, 2026
Merged

Add GitHub Pages deploy and site config#1
mohit-nagaraj merged 1 commit intomainfrom
dev

Conversation

@mohit-nagaraj
Copy link
Member

Add a GitHub Actions workflow to build and deploy the site to GitHub Pages (on push to main and manual dispatch). Set site URL and favicon in astro.config.mjs, rename package to 'kubeorch-docs' in package.json, add public/CNAME (docs.kubeorch.dev) and a new favicon.ico while removing the SVG favicon, and add .claude/settings.local.json to grant local permissions for web fetch and npm/gh bash commands.

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

  • Design: A design document was considered and is present (link) or not required
  • PR: The PR description is expressive enough and will help future contributors
  • Code: Write code that humans can understand and Keep it simple
  • Refactor: You have left the code cleaner than you found it (Boy Scout Rule)
  • Upgrade: Impact of this change on upgrade flows was considered and addressed if required
  • Testing: New code requires new unit tests. New features and bug fixes require at least one e2e test
  • Documentation: A user-guide update was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature / API change.
  • Community: Announcement to the community was considered

Release note:

None

@mohit-nagaraj mohit-nagaraj self-assigned this Feb 16, 2026
@gemini-code-assist
Copy link

Summary of Changes

Hello @mohit-nagaraj, I'm Gemini Code Assist1! 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 establishes the foundational infrastructure for deploying the documentation site to GitHub Pages. It configures the necessary deployment workflow, updates core site settings for URL and favicon, and adjusts the project's package identification. Additionally, it prepares for custom domain usage and sets up local development permissions, streamlining the process for future contributions and site maintenance.

Highlights

  • GitHub Pages Deployment: A GitHub Actions workflow has been added to enable building and deploying the site to GitHub Pages, triggered on pushes to the main branch and via manual dispatch.
  • Site Configuration Updates: The Astro configuration (astro.config.mjs) has been updated to set the site URL to https://docs.kubeorch.dev and specify /favicon.ico as the favicon.
  • Package Renaming: The project package name in package.json has been changed from an empty string to kubeorch-docs.
  • Custom Domain and Favicon Management: A public/CNAME file was added to configure the custom domain docs.kubeorch.dev, and the old public/favicon.svg was removed, implying a new favicon.ico will be used.
  • Local Development Permissions: A new .claude/settings.local.json file was introduced to grant local permissions for web fetch operations and specific npm/gh bash commands.
Changelog
  • .claude/settings.local.json
    • Added a new file to define local permissions for WebFetch and Bash commands.
  • astro.config.mjs
    • Set the site configuration to https://docs.kubeorch.dev.
    • Configured the favicon to /favicon.ico within the Starlight integration.
  • package-lock.json
    • Added "peer": true to the acorn dependency entry.
    • Added "peer": true to the astro dependency entry.
    • Added "peer": true to the postcss dependency entry.
    • Added "peer": true to the rollup dependency entry.
    • Added "peer": true to the vite dependency entry.
    • Added "peer": true to the zod dependency entry.
  • package.json
    • Renamed the project package from an empty string to kubeorch-docs.
  • public/CNAME
    • Added a new file containing the custom domain docs.kubeorch.dev.
  • public/favicon.svg
    • Removed the SVG favicon file.
Ignored Files
  • Ignored by pattern: .github/workflows/** (1)
    • .github/workflows/deploy.yml
Activity
  • No human activity (comments, reviews) has been recorded on this pull request yet.
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.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds the necessary configuration to build and deploy the documentation site to GitHub Pages. The changes include setting the site URL, favicon, package name, and adding a CNAME file. A configuration file for the Claude AI assistant is also added. My review includes one high-severity security comment regarding the broad permissions granted in the new .claude/settings.local.json file, which should be scoped more narrowly.

Add a GitHub Actions workflow to build and deploy the site to GitHub Pages (on push to main and manual dispatch). Set site URL and favicon in astro.config.mjs, rename package to 'kubeorch-docs' in package.json, add public/CNAME (docs.kubeorch.dev) and a new favicon.ico while removing the SVG favicon, and add .claude/settings.local.json to grant local permissions for web fetch and npm/gh bash commands.

Signed-off-by: Mohit Nagaraj <mohitnagaraj20@gmail.com>
@mohit-nagaraj mohit-nagaraj merged commit 0fa73d3 into main Feb 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant