This folder contains visual assets for the CoreX documentation.
images/ - Screenshots, photos, and other image assets
diagrams/ - Architecture diagrams, flowcharts, and technical diagrams
[Naming conventions for asset files]
- Use lowercase with hyphens:
architecture-overview.png - Include descriptive names:
frontend-component-structure.svg
- Preferred: PNG for screenshots
- SVG for icons and logos
- JPEG for photos
- Preferred: SVG for scalability
- PNG for compatibility
- Source files (e.g.,
.drawio,.puml) should be included
- Place files in the appropriate subfolder
- Use descriptive file names
- Reference the asset in relevant documentation
- Include source files when applicable
[Guidelines for optimizing file sizes]
[How to provide attribution for external assets]