Merged
Conversation
There was a problem hiding this comment.
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.
wborn
approved these changes
Jan 15, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.