Skip to content

Add Playwright and mdbook instructions for documentation changes#329

Merged
Mossaka merged 3 commits into
mainfrom
copilot/add-playwright-instructions
Oct 3, 2025
Merged

Add Playwright and mdbook instructions for documentation changes#329
Mossaka merged 3 commits into
mainfrom
copilot/add-playwright-instructions

Conversation

Copilot AI commented Oct 3, 2025

Copy link
Copy Markdown
Contributor

Overview

This PR adds a new Copilot instruction file that guides developers to use Playwright for displaying visual changes when working on documentation modifications, and provides instructions for running the documentation locally with mdbook.

Changes

Created .github/instructions/docs.instructions.md with:

  • YAML frontmatter targeting docs/**/*.md files
  • Instructions on running documentation locally using mdbook (just docs-build, just docs-watch, just docs-serve)
  • Instructions to use Playwright tools (playwright-browser_navigate and playwright-browser_take_screenshot) for capturing visual changes
  • Guidance on comparing before/after screenshots to demonstrate the impact of documentation modifications
  • Emphasis on including visual evidence in progress reports

Why This Matters

Documentation changes often affect visual presentation, layout, and formatting. By providing instructions for running docs locally and using Playwright to capture screenshots, reviewers can:

  • Build and preview documentation changes locally before capturing screenshots
  • Quickly understand the visual impact of changes without building the documentation themselves
  • Identify unintended formatting issues or layout problems
  • Validate that documentation renders correctly across different scenarios
  • Make more informed decisions during code review

Format Consistency

The new instruction file follows the same structure as existing instruction files in the repository:

  • Uses YAML frontmatter with applyTo field for file targeting
  • Provides clear, actionable guidance
  • Maintains consistent formatting with changelog.instructions.md and rust.instructions.md

Fixes the issue by providing automated guidance to Copilot whenever documentation files are being modified.

Original prompt

Add a short instruction to copilot instrucitons markdown file in the .github named docs.instructions.md that tells copilot to use playwrite to display visual changes whenever the task is related to docs changes


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Playwright instruction for visual changes in docs Add Playwright instructions for documentation changes Oct 3, 2025
Copilot AI requested a review from Mossaka October 3, 2025 21:35
@Mossaka Mossaka marked this pull request as ready for review October 3, 2025 21:36
@Mossaka

Mossaka commented Oct 3, 2025

Copy link
Copy Markdown
Contributor

@copilot you should also add some instructions on how to run the docs using mdbook

Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>

Copilot AI commented Oct 3, 2025

Copy link
Copy Markdown
Contributor Author

@copilot you should also add some instructions on how to run the docs using mdbook

Added mdbook instructions in commit d474e0d. The file now includes a "Running the Documentation Locally" section with commands for building (just docs-build) and serving (just docs-watch, just docs-serve) the documentation, as well as direct mdbook commands.

Copilot AI changed the title Add Playwright instructions for documentation changes Add Playwright and mdbook instructions for documentation changes Oct 3, 2025
Copilot AI requested a review from Mossaka October 3, 2025 21:54
@Mossaka Mossaka merged commit 2f5d00e into main Oct 3, 2025
15 checks passed
@Mossaka Mossaka deleted the copilot/add-playwright-instructions branch October 3, 2025 22:20
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.

2 participants