Feature/docs

[qchapp]

This pull request introduces comprehensive documentation and workflow improvements to support contributors and users of the AI Imaging Agent project. The main changes include adding detailed guides for installation, configuration, project structure, and contribution, as well as setting up a CI workflow for deploying documentation using MkDocs and GitHub Pages.

Documentation additions:

• Added docs/development/contributing.md with step-by-step instructions for contributing, development workflow, code style, commit message conventions, PR guidelines, tool catalog expansion, and code review/release processes.
• Added docs/development/structure.md outlining the project directory layout, module boundaries, import patterns, extension points, configuration/data files, and testing structure.
• Added docs/getting-started/installation.md with installation steps, troubleshooting, Docker usage, and verification instructions.
• Added docs/getting-started/configuration.md detailing environment variables, model configuration, logging, software catalog setup, and verification steps.

CI/CD workflow:

• Added .github/workflows/deploy_docs.yml to automate documentation build and deployment with MkDocs Material and GitHub Pages on pushes to the develop branch.

[Copilot]

Pull request overview

This PR adds a MkDocs (Material) documentation site for the AI Imaging Agent and introduces a GitHub Actions workflow to build and deploy those docs to GitHub Pages, alongside minor dependency updates to support the docs toolchain.

Changes:

• Add a MkDocs Material site configuration (mkdocs.yml) and a set of new documentation pages under docs/ (getting started, user guide, architecture, development, reference).
• Add a GitHub Actions workflow to build docs and deploy to GitHub Pages on pushes to develop.
• Add mkdocs-material to the project’s dev optional dependencies.

Reviewed changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
pyproject.toml	Adds mkdocs-material to dev dependencies for local docs development.
mkdocs.yml	Defines MkDocs Material configuration, plugins, extensions, and navigation for the docs site.
docs/index.md	Adds docs landing page describing the project and linking into the docs sections.
docs/getting-started/installation.md	Adds installation guide (prereqs, venv setup, Docker) and verification steps.
docs/getting-started/configuration.md	Adds configuration guide for .env and config.yaml model settings.
docs/getting-started/quickstart.md	Adds quickstart walkthrough for first run and basic usage patterns.
docs/user-guide/chat-interface.md	Documents the chat UI layout, workflow, and control tags.
docs/user-guide/file-formats.md	Documents supported formats, metadata extraction, and preview generation behavior.
docs/user-guide/recommendations.md	Explains ranking/scoring and how to interpret recommendations.
docs/user-guide/running-demos.md	Documents demo-running behavior and troubleshooting.
docs/user-guide/advanced-features.md	Documents advanced features (tags, alternative searches, multi-model) and debug tooling.
docs/architecture/overview.md	Provides system architecture overview and data flow explanation.
docs/architecture/retrieval.md	Describes retrieval pipeline stages (query enhancement, FAISS, reranking).
docs/architecture/agent.md	Describes agent/VLM selection stage, tools, schemas, and error handling.
docs/architecture/catalog.md	Documents catalog schema, management, sync, and embedding/index workflow.
docs/development/structure.md	Documents repo/module structure, boundaries, and extension points.
docs/development/contributing.md	Provides contribution workflow guidance, PR checklist, and catalog contribution steps.
docs/development/testing.md	Documents testing strategy, organization, mocking, and CI guidance.
docs/reference/cli.md	Documents CLI commands and troubleshooting.
docs/reference/environment.md	Documents environment variables and security best practices.
docs/reference/changelog.md	Adds documentation-facing changelog page and links to root CHANGELOG.md.
.github/workflows/deploy_docs.yml	Adds CI workflow to build MkDocs site and deploy to GitHub Pages from develop.

---

You can also share your feedback on Copilot code review. Take the survey.

[Copilot]

@qchapp I've opened a new pull request, #24, to work on those changes. Once the pull request is ready, I'll request review from you.

[Copilot]

Pull request overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated 10 comments.

---

You can also share your feedback on Copilot code review. Take the survey.

[qchapp]

The documentation is not 100% ready but it is better to continue the development in the develop branch. No need for a separate branch for this.