Skip to content

Add Docusaurus documentation website with GitHub Pages deployment#53

Merged
dennisdoomen merged 5 commits intomainfrom
copilot/create-documentation-website
Feb 14, 2026
Merged

Add Docusaurus documentation website with GitHub Pages deployment#53
dennisdoomen merged 5 commits intomainfrom
copilot/create-documentation-website

Conversation

Copy link
Contributor

Copilot AI commented Jan 28, 2026

Adds a documentation website using Docusaurus to replace inline README documentation with a structured, searchable site deployable to GitHub Pages.

Changes

Documentation Structure

  • website/ - Docusaurus 3.9.2 installation with TypeScript
  • Restructured README content into logical pages:
    • intro.md - Platform support and key features
    • quick-start.md - Installation and basic examples
    • usage.md - Core functionality reference
    • advanced.md - Custom matchers, body matching, assertions
    • building.md - Build instructions
    • contributing.md - Guidelines and credits

Branding

  • Applied logo gradient colors: #3BABD9 (cyan) → #5B7DD8 (blue) → #8B5FCE (purple)
  • Custom CSS in src/css/custom.css for hero section and color variables
  • Dark mode support with adjusted palette
  • Logo integrated in navbar and static assets

Deployment

  • .github/workflows/deploy-docs.yml - Automated GitHub Actions workflow
  • Triggers on push to main when website files change
  • Deploys to https://dennisdoomen.github.io/mockly/
  • Added syntax highlighting for C#, Bash, PowerShell

PowerShell Testing Scripts

  • Start-DevServer.ps1 - Start development server with hot-reloading and custom port support
  • Build-Website.ps1 - Build website for production with optional clean build
  • Test-ProductionBuild.ps1 - Serve and test production build locally
  • Test-Website.ps1 - Comprehensive validation suite (files, structure, dependencies, build)
  • All scripts include detailed help documentation accessible via Get-Help
  • Updated website README.md with usage instructions and troubleshooting

Repository Updates

  • .gitignore - Excludes website/build, website/.docusaurus, website/node_modules
  • README.md - Streamlined to remove duplicated documentation content
    • Added prominent Documentation section with links to website pages
    • Removed 600+ lines of detailed usage and advanced features documentation
    • Kept essential About, Key Features, and Quick Start sections
    • Made Building and Contributing sections brief with links to full documentation
    • Reduced from 858 to 250 lines for better maintainability
    • Fixed logo alt text from "PackageGuard" to "Mockly"

Screenshots

Homepage with gradient hero and feature cards:

Documentation pages with sidebar navigation:

Deployment Setup

After merge, enable GitHub Pages:

  1. Repository Settings → Pages
  2. Source: GitHub Actions
  3. Site deploys automatically on next push to main

Local Testing (Windows)

cd website

# Start development server
.\Start-DevServer.ps1

# Build for production
.\Build-Website.ps1

# Test production build
.\Test-ProductionBuild.ps1 -Build

# Run validation tests
.\Test-Website.ps1
Original prompt

Create a documentation website based on the contents of the readme. Use Docusarus for that and make it possible to deploy that site using GitHub Pages. Use the color style from the mockly logo.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 28, 2026 18:05
- Initialize Docusaurus in website/ directory
- Configure branding with cyan-to-purple gradient matching logo
- Convert README content to structured documentation pages
- Add GitHub Actions workflow for GitHub Pages deployment
- Update .gitignore for Docusaurus artifacts

Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation website using Docusaurus for GitHub Pages Add Docusaurus documentation website with GitHub Pages deployment Jan 28, 2026
Copilot AI requested a review from dennisdoomen January 28, 2026 18:09
@dennisdoomen
Copy link
Owner

@copilot please add some command-line (Powershell) scripts to test the website locally

- Start-DevServer.ps1: Start development server with hot-reloading
- Build-Website.ps1: Build website for production
- Test-ProductionBuild.ps1: Serve and test production build
- Test-Website.ps1: Run comprehensive validation tests
- Added detailed README with script usage and examples

Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 28, 2026

@copilot please add some command-line (Powershell) scripts to test the website locally

Added PowerShell scripts for local testing in commit fb258d4:

Scripts included:

  • Start-DevServer.ps1 - Start development server with hot-reloading
  • Build-Website.ps1 - Build for production with optional clean
  • Test-ProductionBuild.ps1 - Serve production build locally
  • Test-Website.ps1 - Comprehensive validation tests

Usage examples:

cd website

# Start dev server
.\Start-DevServer.ps1

# Build for production  
.\Build-Website.ps1

# Test production build
.\Test-ProductionBuild.ps1 -Build

# Run tests
.\Test-Website.ps1

All scripts include detailed help accessible via Get-Help .\ScriptName.ps1 -Detailed

See the website README.md for complete documentation.

Copy link
Owner

Choose a reason for hiding this comment

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

@copilot remove the duplicated documentation from the read-me and makes sure the documentation section points to the new docusaurus website

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Streamlined the README in commit 4501880:

Changes made:

  • Removed 600+ lines of duplicated detailed documentation
  • Added prominent Documentation section at top with direct links to:
    • Quick Start guide
    • Usage guide
    • Advanced Features
    • Building instructions
    • Contributing guidelines
  • Kept essential About, Key Features, and Quick Start sections
  • Made Building and Contributing sections brief with links to full documentation
  • Fixed logo alt text from "PackageGuard" to "Mockly"

The README is now 250 lines (down from 858) and serves as a landing page that directs users to the comprehensive documentation website at https://dennisdoomen.github.io/mockly/

- Removed duplicated detailed documentation content
- Added prominent Documentation section with links to website
- Kept About, Key Features, and Quick Start sections
- Made Building and Contributing sections brief with links to full docs
- Reduced from 858 to 250 lines for better maintainability
- Fixed alt text for logo from "PackageGuard" to "Mockly"

Co-authored-by: dennisdoomen <572734+dennisdoomen@users.noreply.github.com>
@coveralls
Copy link

coveralls commented Feb 14, 2026

Pull Request Test Coverage Report for Build 22014300874

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 64 unchanged lines in 6 files lost coverage.
  • Overall coverage decreased (-1.0%) to 82.637%

Files with Coverage Reduction New Missed Lines %
Mockly/RequestCollection.cs 2 83.33%
Mockly/RequestMockBuilder.cs 2 95.96%
Mockly/RequestInfo.cs 12 55.21%
Mockly/HttpMock.cs 14 91.67%
Mockly/RequestMock.cs 17 78.5%
Shared/HttpMockAssertionExtensions.cs 17 82.06%
Totals Coverage Status
Change from base Build 20614328858: -1.0%
Covered Lines: 1141
Relevant Lines: 1312

💛 - Coveralls

@dennisdoomen dennisdoomen marked this pull request as ready for review February 14, 2026 09:04
@dennisdoomen dennisdoomen merged commit d1c55ea into main Feb 14, 2026
4 of 5 checks passed
@dennisdoomen dennisdoomen deleted the copilot/create-documentation-website branch February 14, 2026 09:04
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