Skip to content

About this portal

This is the internal documentation portal for Aviando's Salesforce AI agents. It is only reachable for @aviando.io accounts.

How it is built

Each agent keeps its own documentation in its own repository, under a docs/ folder. This portal (agent-docs) aggregates those folders into one site:

flowchart LR
  A1[agent-data-enrichment/docs] --> P[agent-docs\nbuild]
  A2[agent-lead-signals/docs] --> P
  A3[agent-…/docs] --> P
  P --> S[docs.aviando.ai\nMkDocs Material]

The build runs scripts/aggregate.py, which reads agents.yml, pulls each live agent's docs/ folder and generates the Agents navigation. The site is then built with MkDocs Material and deployed to Cloudflare Pages, with Cloudflare Access enforcing Google SSO for the aviando.io domain in front of it.

Documenting a new agent

  1. Add a docs/ folder to the agent's repository (the agent-template ships the structure and a prompt to generate it).
  2. Add the agent to agents.yml in this repo and set status: live.
  3. The next portal build picks up its docs automatically.

Keeping it fresh

The portal rebuilds automatically: on every push to this repo, on a daily schedule, and on demand. So when you update an agent's docs/, the portal refreshes within a day without any action here — or immediately if you trigger a rebuild.