Back to all reviewers

Keep documentation paths current

appwrite/appwrite
Based on 7 comments
PHP

Maintain accurate and consistent documentation paths, references, and descriptions across the codebase. When terminology or architecture changes, ensure all documentation references are updated to reflect the current state.

Documentation PHP

Reviewer Prompt

Maintain accurate and consistent documentation paths, references, and descriptions across the codebase. When terminology or architecture changes, ensure all documentation references are updated to reflect the current state.

Example of proper documentation path updates:

// In SDK method definition
-description: '/docs/references/databases/update-attribute-enum.md',
+description: '/docs/references/databases/update-column-enum.md',

// In parameter description
-->param('attribute', '', new Key(), 'Document ID.')
+->param('attribute', '', new Key(), 'Attribute key.')

Key points:

  • Update documentation paths when endpoints or features are renamed
  • Ensure parameter descriptions accurately reflect their purpose
  • Maintain consistency between code terminology and documentation
  • Review all related files when making terminology changes
  • Keep API references synchronized with implementation changes
7
Comments Analyzed
PHP
Primary Language
Documentation
Category

Source Discussions