This folder contains images, assets, and other media files used in the documentation.
overview.gif- Overview animation showing the language server features
Resources in this folder can be referenced in documentation files using relative paths:
Or from other folders:
When adding new resources:
- Use descriptive names - Name files clearly (e.g.,
completion-demo.gif,entity-validation.png) - Optimize file sizes - Compress images to keep the repository size reasonable
- Use appropriate formats:
.pngfor screenshots with text or sharp edges.jpgfor photos.giffor short animations.svgfor diagrams and icons (when possible)
- Update this README - Add new files to the contents list above
- Reference in documentation - Make sure to use the resource in relevant documentation
- Screenshots: Should be clear and focused on the relevant feature
- Animations: Keep under 5MB when possible, show key interactions
- Diagrams: Use simple, clear visuals that complement the text
- Resolution: Use appropriate resolution (high enough to be clear, but not unnecessarily large)
Recommended tools for creating documentation resources:
- Screenshots: Built-in OS tools, ShareX (Windows), Flameshot (Linux)
- GIF recording: ScreenToGif, LICEcap, Peek
- Image optimization: TinyPNG, ImageOptim, pngquant
- Diagrams: Draw.io, Excalidraw, Mermaid
- Main Documentation - All documentation files
- Contributing Guide - General contribution guidelines