Menu
Add documentation for contributors and developers.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | documentation |
| description | Add documentation for contributors and developers. |
Documentation exists in 3 forms, code comments, design/architectural documentation that is made up of markdown files describing code flow and core concepts (such as DESIGN.md), and the documentation website.
Design/architectural documentation such as DESIGN.md should always be kept up-to-date.
The website captures the documentation primarily for the @microsoft/fast-element package. Other packages are treated as tangential, so testing packages or other utilities should have their own sections.
The website has been written in 11ty and primarily consists of markdown files. When making changes, ensure that the website has been scanned on whichever latest major version is available. These are organized by folder, so if 1.x/2.x/3.x folders are available, you will update the documentation in the 3.x folder.
If you are making a breaking change, ensure the migration document has been updated.
All markdown documentation aside from the package/crate level DESIGN.md files are in that package/crates docs folder.
Any documentation created for the website should be written with the developer implementing the package in mind, it is not intended for other audiences.
Use this skill when contributing changes to the FAST monorepo — creating pull requests, generating change files, writing PR descriptions, and keeping documentation up to date.
Use this guide when working on TypeScript changes in the FAST monorepo — authoring Web Components, writing templates and styles, working with the observable/reactive system, and testing.
Use this skill when running or writing tests in the FAST monorepo — local test execution, CI workflows, Playwright fixtures, and WebUI integration testing.
Use this guide when working on Rust changes in the FAST monorepo.
Generate a bug report issue for the FAST repository using the provided template.
Generate a feature request issue for the FAST repository using the provided template.
