Documentation Guidelines

This directory (docs) serves as the primary documentation repository for the project. All team members should follow these guidelines:

Core Principles

1. Single Source of Truth: This docs directory is the main repository for all project documentation.
2. Continuous Updates: Documentation must be updated whenever:
   • Code changes are made
   • Issues are resolved
   • New features are implemented
   • Bug fixes are applied

Best Practices

1. Pre-Change Check: Before making any changes to the codebase:

   • Review relevant documentation in this directory
   • Avoid duplicating existing information
   • Identify potential impacts on existing documentation

2. Regular Review:

   • Periodically review documentation for accuracy
   • Update outdated information
   • Identify areas needing more detailed documentation

3. Documentation Structure:

   • Keep documentation organized and easy to navigate
   • Use clear, consistent formatting
   • Include examples where appropriate
   • Link related documents together

Current Documentation

The following documentation is currently available:

• documentation_script_readme.md: Script documentation
• documentation_strategy.md: Documentation strategy
• form_schema_audit.md: Form schema auditing
• laraxot.md: Laraxot framework documentation
• module_geo.md: Geographic module documentation
• project.md: Project overview
• widget.md: Widget documentation

Contributing

When contributing to documentation:

1. Use clear and concise language
2. Include relevant code examples
3. Update the table of contents if necessary
4. Cross-reference related documentation
5. Commit documentation changes along with code changes