Screenshots and visual aids play a critical role in documenting the osintbuddy project. They help clarify complex UI states, illustrate new features, demonstrate workflows, and provide visual evidence for bug reports or proposed changes. Well-chosen visuals can significantly improve the clarity and accessibility of both user-facing and developer-facing documentation.
Capture screenshots or other relevant visuals when introducing new UI features, documenting workflow steps, reporting or fixing UI-related bugs, or when a visual context will help reviewers or users understand the impact of a change. Annotate images to highlight important elements, such as new buttons, changed layouts, or error messages, using simple shapes or callouts for clarity.
Although osintbuddy does not enforce a formal standard for organizing images, contributors should follow general best practices. Store images in a dedicated directory within the documentation or project structure, such as docs/assets or images. Use descriptive, lowercase filenames with hyphens (for example, entity-graph-expanded.png or login-error-message.png) to make assets easy to identify and reference. When possible, use relative paths to reference images, which ensures portability across different environments and branches.
To include images in markdown documentation or pull requests, use the standard markdown syntax:
Provide a concise alt text describing the image’s content. In pull requests, embed screenshots inline with the relevant discussion or code diff to give reviewers immediate visual context. Always explain the purpose of the visual in the surrounding text, so readers understand what to look for and why it matters.
While there are no project-specific requirements for screenshot tools or formats, use widely supported formats such as PNG or JPEG, and keep file sizes reasonable to avoid bloating the repository. If you annotate screenshots, ensure annotations are clear and do not obscure critical UI elements.
In summary, use screenshots and visual aids whenever they clarify, illustrate, or support your documentation or code review. Organize and reference them logically, using relative paths and descriptive names, and always provide context for their inclusion. This approach maintains clarity and consistency across the project’s documentation and review processes.