Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.6 KB

File metadata and controls

34 lines (24 loc) · 1.6 KB

Contributing

See the README for licensing and legal information.

Types of Changes

Wanted Changes

  1. Fixes to incorrect statements or inaccuracies within the documentation.
  2. Rewording or extending documentation to clarify unclear wording or complicated explanations.
  3. Additions that fill gaps or missing pieces in the current documentation.
  4. Fixing of spelling and grammatical errors in the documentation.

Unwanted Changes

  1. Whitespace or formatting changes.
  2. Subjective wording changes.
  3. Modifications to the overall structure and format of the API docs.
  4. Additions that replicate or needlessly restructure current documentation.
  5. Additions that document unreleased product functionality.
  6. Changes that modify Community Resources (see guidelines for more detail).

Markdown Syntax

Our documentation uses standard Markdown syntax with some additional MDX features.

We also support the following formatting from Mintlify: