7 Documentation guidelines

Joshua Smithrud редактировал(а) эту страницу 2022-07-14 17:07:50 -07:00

Содержание

• Source-Code Documentation Guidelines

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.

• Documentation Dos and Don'ts
• Fluid Terminology

Source-Code Documentation Guidelines

• TypeScript Documentation Guidelines
• JavaScript Documentation Guidelines

Overview

• Wiki Home
• Usage Documentation (fluidframework.com)
• FAQ (fluidframework.com)

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
    • API Type Validation
    • Communicating Breaking Changes
    • Changesets
  • Branches, Versions, and Releases
  • Compatibility & Versioning
  • Testing
    • Bundle Size Tests
  • Debugging
  • npm package scopes
  • Maintaining API support levels
  • Developer Tooling Maintenance
  • API Deprecation
  • Working with the Website (fluidframework.com)
    • Building Documentation Locally
• Coding Guidelines
• Documentation Guidelines
  • Where To Put Documentation
  • Documentation Dos and Don'ts
  • Fluid Terminology
  • Documenting TypeScript
    • TSDoc Guidelines
    • Release Tags
  • Documenting JavaScript
  • Markdown Best Practices
• 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.