Skip to content

Conversation

@denniskuijs
Copy link
Member

No description provided.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR creates a new Docusaurus-based handbook skeleton for OpenRemote, setting up the foundation for documentation hosted at https://handbook.openremote.io/. The PR includes all necessary configuration files, styling, assets, and CI/CD pipeline for automatic deployment to GitHub Pages.

Changes:

  • Added Docusaurus 3.9.2 with TypeScript support and necessary configuration files
  • Set up GitHub Actions CI/CD workflow for automated build and deployment
  • Added initial documentation structure with a basic introduction page
  • Configured custom CSS styling, branding assets (logos, favicon), and search integration (Algolia)

Reviewed changes

Copilot reviewed 10 out of 18 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
package.json Defines project dependencies, scripts, and Docusaurus 3.9.2 setup
docusaurus.config.ts Configures site metadata, navigation, footer, theme, and integrations (GTM, Algolia)
tsconfig.json TypeScript configuration extending Docusaurus defaults
sidebars.ts Defines documentation sidebar structure with introduction page
src/pages/index.tsx Home page that redirects to introduction documentation
src/css/styles.css Custom CSS with theme variables and DocSearch styling
static/img/* Branding assets including logo, favicon, and social card
static/.nojekyll Prevents GitHub Pages from using Jekyll processing
.github/workflows/ci_cd.yml CI/CD pipeline for building and deploying to GitHub Pages
.gitignore Standard ignore patterns for Docusaurus, Node.js, and IDEs
.yarnrc.yml Yarn v4 configuration
CNAME Custom domain configuration for GitHub Pages
README.md Project documentation with setup and deployment instructions
docs/introduction.md Initial documentation page skeleton

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@denniskuijs denniskuijs merged commit 5ef9db3 into main Jan 15, 2026
2 checks passed
@denniskuijs denniskuijs deleted the feature/handbook-skeleton branch January 15, 2026 14:06
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.

3 participants