Merged
Conversation
- Add netlify.toml with build:all command and routing rules - Update package.json with build:all and copy:docs scripts - Configure VitePress with /docs base path and Vue.js integration - Create custom VitePress theme importing project styles - Add getting-started documentation page - Set up proper directory structure for combined deployment 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Update NODE_VERSION from 18 to 20 in netlify.toml - Resolves Vite build error requiring Node.js 20.19+ or 22.12+ - Fixes crypto.hash compatibility issue with @vitejs/plugin-vue 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Added missing semicolons in utils.ts for consistency. - Added blank lines in style.css for improved readability.
- Introduced a new "Documentation" link in the main navigation of App.vue for easy access to the testing guide. - Updated CallToActionSection.vue to link to the documentation instead of the GitHub README. - Modified HeroSection.vue to point to the documentation instead of the GitHub README.
- Refactored test setup and utility functions for better readability and consistency. - Updated README.md for testing with clearer instructions and examples. - Enhanced performance tests with additional scenarios and improved assertions. - Added support for linting markdown files in eslint configuration. - Updated package.json and package-lock.json to include eslint-plugin-markdown. - Improved utility function for class name merging in utils.ts.
- Created a comprehensive Setup & Deployment Guide for Altus 4, detailing installation, configuration, and initial setup steps. - Added a Testing Guide covering unit, integration, performance, and end-to-end testing strategies, including examples and best practices. - Updated netlify.toml to improve redirect rules for VitePress documentation and Vue.js SPA routing.
- Introduced a comprehensive Documentation Sync Setup Guide to automate synchronization between the main repository's `docs/` directory and the `altus4/docs` repository. - Added a GitHub Actions workflow for automatic documentation syncing on changes to the `docs/` directory and README. - Updated `package.json` to include scripts for manual synchronization. - Enhanced README.md to reflect the new documentation structure and sync capabilities. - Created a sync script for manual synchronization of documentation. - Added testing script to validate the documentation sync setup.
- Updated the Documentation Sync Setup Guide for clarity and added new steps for verification. - Improved formatting in various markdown files for consistency and readability. - Adjusted ESLint configuration to disable specific rules for markdown files and updated related scripts in package.json. - Refined GitHub Actions workflow to ensure proper repository checks. - Made minor adjustments to the README.md for better structure and clarity.
…ation step for improved documentation sync reliability
- Add sync test status section to main documentation page - Add sync test info box to architecture documentation - These changes will help verify the GitHub Actions workflow - Should appear in altus4/docs repository automatically
…ation - Set up the documentation repository with a comprehensive README - Create package.json for VitePress configuration and scripts - Implement GitHub Actions workflow for automatic deployment - Add .gitignore tailored for Node.js/VitePress projects - Establish initial documentation structure with placeholder content This repository will automatically sync from the main altus4/website repository.
- Remove emojis from all documentation files - Remove emojis from script files and README - Remove emojis from setup and configuration files - Maintain professional tone throughout codebase - Keep functionality intact while improving readability Files updated: - docs/index.md - docs/architecture/index.md - docs/examples/index.md - docs/setup/index.md - docs/development/git-workflow.md - scripts/sync-docs.sh - scripts/test-sync-setup.sh - scripts/initialize-docs-repo.sh - README.md - DOCS_SYNC_SETUP.md
Thavarshan
added
documentation
✅ Deploy Preview for altus4 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR integrates VitePress as the documentation system for Altus 4, establishing automated documentation synchronization between the main website repository and a dedicated docs repository. The implementation includes comprehensive documentation across all system components, build configuration for dual website/docs deployment, and automation scripts for maintaining documentation consistency.
Key changes:
- Added VitePress configuration and comprehensive documentation structure covering API, architecture, services, testing, and setup guides
- Implemented automated docs synchronization system with scripts for initializing and syncing to a separate docs repository
- Updated build system to support dual deployment (main website + docs subfolder) with proper routing configuration
Reviewed Changes
Copilot reviewed 26 out of 28 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/style.css | Minor CSS formatting improvements with additional whitespace |
| src/components/HeroSection.vue | Updated documentation link to point to local /docs/ instead of external GitHub |
| src/components/CallToActionSection.vue | Updated documentation link to point to local /docs/ instead of external GitHub |
| src/App.vue | Added "Documentation" navigation links in both desktop and mobile menus |
| scripts/test-sync-setup.sh | Added comprehensive test script to validate documentation sync setup |
| scripts/sync-docs.sh | Added main synchronization script for pushing docs to separate repository |
| scripts/initialize-docs-repo.sh | Added initialization script for setting up the docs repository structure |
| package.json | Updated project configuration with VitePress dependencies and docs-related scripts |
| netlify.toml | Added deployment configuration for handling both website and docs routing |
| eslint.config.js | Extended ESLint configuration to handle markdown files and VitePress setup |
| docs/testing/index.md | Added comprehensive testing documentation with examples and best practices |
| docs/setup/index.md | Added detailed setup and deployment guide with troubleshooting |
| docs/services/search-service.md | Added detailed SearchService documentation with implementation details |
| docs/services/index.md | Added service layer overview and documentation index |
| docs/index.md | Added main documentation homepage with quick start and navigation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
✅ Deploy Preview for altus4-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.