core/docs/AGENTS.md at main · api-platform/core · GitHub
Skip to content

Latest commit

 

History

History
18 lines (12 loc) · 534 Bytes

AGENTS.md

File metadata and controls

18 lines (12 loc) · 534 Bytes

Context: API Platform Documentation

Documentation Standards

  • Tone: Technical, concise, and helpful. Avoid overly marketing language.
  • Format: Markdown (GitHub flavored).
  • Links: Use relative links for internal navigation.

Directory Structure

  • guides/: Learning oriented guides (How-to).
  • adr/: Architectural Decision Records.
  • src/: API Reference generation source.

Contribution

  • Documentation changes for new features are mandatory.
  • Verify links before finalizing content.