-
Notifications
You must be signed in to change notification settings - Fork 534
Documentation guidelines
Joshua Smithrud edited this page Jul 15, 2022
·
7 revisions
The Fluid Framework is an open-source project that has production customers. As such, it is imperative that it has quality documentation.
The following documents outline best practices for writing documentation for the Fluid Framework, to ensure our documentation is consistent and of high quality.
This wiki is focused on contributing to the Fluid Framework codebase.
For information on using Fluid Framework or building applications on it, please refer to fluidframework.com.
- Submitting Bugs and Feature Requests
-
Contributing to the Repo
- Repo Basics
- Common Workflows and Patterns
- Managing dependencies
- Client Code
- Server Code
- PR Guidelines
- CI Pipelines
- Breaking vs Non-Breaking Changes
- Branches, Versions, and Releases
- Compatibility & Versioning
- Testing
- Debugging
- npm package scopes
- Maintaining API support levels
- Developer Tooling Maintenance
- API Deprecation
- Working with the Website (fluidframework.com)
- Coding Guidelines
- Documentation Guidelines
- CLA