Содержание
(This document is a work in progress)
fluidframework.com
Our public website can be found at https://fluidframework.com/.
Website Contents
The website is made up of a mix of authored and generated content.
Authored contents can be found under docs/content. For guidelines and tips for authoring website content, see here.
The website also publishes automatically generated API documentation for our public library packages. This documentation can be found here. These contents are generated using API-Extractor and our @fluid-tools/api-markdown-documenter library. For more details on our API documentation generation, see here.
Website Build
Documentation regarding building / testing the website locally can be found here.
Overview
Contributing
- 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
Using Fluid Framework
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.