Skip to content

Rewite the docs and Copilot instructions#3442

Merged
mattleibow merged 2 commits into
mainfrom
dev/docs-again
Jan 20, 2026
Merged

Rewite the docs and Copilot instructions#3442
mattleibow merged 2 commits into
mainfrom
dev/docs-again

Conversation

@mattleibow
Copy link
Copy Markdown
Collaborator

This pull request refactors and reorganizes the AI assistant instructions for the SkiaSharp project. The changes focus on improving clarity, consolidating information, and making the instructions more concise and easier to follow for contributors and AI coding agents. The most important updates include a major rewrite of the main Copilot instructions, removal of redundant content, and streamlining of layer-specific instruction files.

Major documentation and instruction refactoring:

  • .github/copilot-instructions.md: Completely rewritten to provide a clear, architecture-focused overview for AI assistants, including pointer types, error handling, directory structure, build/generation steps, and layer-specific rules. The new format uses tables, decision trees, and concise code examples for better readability and guidance.

Streamlining and consolidation of instruction files:

  • .github/instructions/README.md: Removed the previous lengthy overview and usage guide for path-specific instructions, consolidating this content into the main Copilot instructions and layer-specific files.

Layer-specific instruction improvements:

Group: C API Layer

Group: C# Bindings Layer

Group: Documentation

@mattleibow mattleibow merged commit 4d272b6 into main Jan 20, 2026
@mattleibow mattleibow deleted the dev/docs-again branch January 20, 2026 22:32
@github-actions
Copy link
Copy Markdown
Contributor

Triage Summary

Labels will be applied to indicate the affected areas of the backend (SkiaSharp) and documentation related to project clarity.

This issue is not a regression as it focuses solely on documentation refactoring and instruction improvements without impacting functionality.

Additional remarks:

  • There were no appropriate labels available for assignment related to operating systems or platforms.
  • The issue focuses on enhancing documentation clarity and organization without affecting compatibility, performance, or reliability.
Detailed Summary and Actions

Summary of the triage:

  • The issue pertains to the backend area specific to the SkiaSharp project due to refactoring of instructions and documentation.
  • The focus is on improving documentation clarity and conciseness.
  • No regression is indicated as it does not affect functionality or performance.

Summary of the actions that will be performed:

Action Item Description
Apply Label backend/SkiaSharp The issue specifically refers to a refactor of instructions and documentation related to the SkiaSharp project.
Apply Label area/Docs The issue focuses on refactoring and reorganizing documentation, improving clarity and conciseness.

This entire triage process was automated by AI and mistakes may have been made. Please let us know so we can continue to improve.

@github-actions github-actions Bot added area/Docs Issues relating to documentation, such as API docs or conceptual docs. backend/SkiaSharp labels Jan 20, 2026
@mattleibow mattleibow added the copilot Created by GitHub Copilot label Feb 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/Docs Issues relating to documentation, such as API docs or conceptual docs. copilot Created by GitHub Copilot

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant