Contributing
Flowintel’s application repository contains the product source and detailed manuals. The documentation repository contains this Hugo website.
Improve the documentation
Open an issue or pull request with the affected page, the behaviour in your application version and the proposed correction. Useful contributions include reproducible setup instructions, practical workflows, API examples and clearer troubleshooting guidance.
When editing this site:
- Change Markdown in
content/and add navigation entries inhugo.tomlwhen introducing a page. - Use Hugo
relreflinks for internal pages so links work under the GitHub Pages subpath. - Put screenshots in
static/images/, remove sensitive content, and supply meaningful alternative text. - Build with
hugo --minify, check links and headings, and preview withhugo server. - Keep generated
public/output out of content changes.
Contribute to the application
Follow the application repository’s AGENTS.md, contributor guide and technical specifications.
The backend uses Flask and SQLAlchemy; frontend dependencies are built with Vite. Tests are organised by feature under tests/. Run checks relevant to the changed feature and build frontend assets when changing their sources.
Use issues for reproducible bugs and feature proposals, and pull requests for changes. For a suspected security vulnerability, follow the application’s security policy.