Skip to main content

Documentation Inventory

A living inventory of user‑facing documentation for Flow Beacon. Use this to track what is published, what remains, and screenshot gaps. Target audience: customers (not developers).

Last updated: auto-maintained by contributors as pages ship.

Completed Pages (Live)​

  • Getting Started
    • Path: docs/getting-started/quickstart.md
    • Notes: First‑value flow with connection/import screenshots; links to Account Access and Make credentials.
  • Connections
    • Path: docs/guides/connections.md
    • Notes: Add/refresh/remove; OAuth tips; links to Make credentials; screenshots added.
  • Import Scenarios (Blueprints)
    • Path: docs/guides/import-scenarios.md
    • Notes: Import from platform + upload blueprint; screenshots added.
  • Validate & Fix
    • Path: docs/guides/validate-and-fix.md
    • Notes: Steps and success criteria; needs validation screenshots.
  • Alerts
    • Path: docs/guides/alerts.md
    • Notes: View/filter/clear; screenshot added.
  • Costs
    • Path: docs/guides/costs.md
    • Notes: Time window + interpretation; needs overview screenshot.
  • Governance (overview)
    • Path: docs/guides/governance.md
    • Notes: Telemetry/Scenarios/Data Stores/RBAC/Audit overview; will link to deeper pages.
  • Telemetry
    • Path: docs/guides/telemetry.md
    • Notes: Interpreting signals; placeholder screenshot.
  • Data Stores
    • Path: docs/guides/data-stores.md
    • Notes: List/create stores, select connection, details/records; placeholder screenshots.
  • Policies
    • Path: docs/guides/policies.md
    • Notes: Create/edit/disable; create from template; placeholder screenshot.
  • Templates
    • Path: docs/guides/templates.md
    • Notes: Browse/preview/use; mapping required fields; placeholder screenshot.
  • Audit Logs
    • Path: docs/guides/audit-logs.md
    • Notes: Filter/export; retention; placeholder screenshot.
  • Settings
    • Path: docs/guides/settings.md
    • Notes: Profile/preferences; links to Teams & Billing.
  • Teams & Roles (RBAC)
    • Path: docs/guides/teams-rbac.md
    • Notes: Roles/invite/change/remove; placeholder screenshot.
  • Billing & Plans
    • Path: docs/guides/billing.md
    • Notes: Plans, payment method, invoices; placeholder screenshots.
  • Account Access
    • Path: docs/guides/account-access.md
    • Notes: Sign in/up/reset; real screenshots added; Private Beta note.
  • Documentation Spec (internal)
    • Path: docs/specs/user-documentation-spec.md
    • Notes: Style/structure/QA; internal reference.

Planned / Missing Pages (User‑Facing)​

  • Dashboard (defer until UI stabilizes)
    • Type: Guide
    • Covers: Widgets/tiles, empty state, quick actions, links to core tasks.
    • Priority: Medium (pending UI changes).
  • Uploaded Blueprints
    • Type: Guide
    • Covers: Difference vs imported, manage list, open details, delete/refresh.
    • Priority: Medium
  • Test Blueprints
    • Type: Guide
    • Covers: Purpose of test environment, safe checks, interpreting outcomes.
    • Priority: Medium ~ Governance — Data Stores (now live)
  • Troubleshooting: Connections
    • Type: Troubleshooting
    • Covers: OAuth pop‑up blocked, wrong account, re‑auth, permissions.
    • Priority: Medium
  • Troubleshooting: Import
    • Type: Troubleshooting
    • Covers: Empty lists, missing scenarios, team/workspace mismatch.
    • Priority: Medium
  • Troubleshooting: Validation
    • Type: Troubleshooting
    • Covers: No results, repeated failures, where to apply fixes.
    • Priority: Medium
  • FAQ: Alerts
    • Type: FAQ
    • Covers: Refresh expectations, what “clear” does, fields explained.
    • Priority: Low
  • FAQ: Costs
    • Type: FAQ
    • Covers: Time zones, data freshness, expected differences vs. provider.
    • Priority: Low
  • Security & Privacy (high‑level)
    • Type: Reference
    • Covers: Brief posture and data handling overview; no internal details.
    • Priority: Low
  • Release Notes (public highlights)
    • Type: Changelog
    • Covers: Notable changes with links to new/updated guides.
    • Priority: Low

Screenshot Backlog (Placeholders to replace)​

Replace pathname:// images with real /img/... once assets are available, then remove the placeholder note.

  • Validate & Fix
    • validation/run-validation.png
    • validation/results.png
  • Costs
    • costs/overview.png
  • Policies
    • policies/list.png
  • Templates
    • templates/gallery.png
  • Audit Logs
    • audit/list.png
  • Telemetry
    • telemetry/overview.png
  • Teams & Roles
    • settings/team-list.png
  • Billing & Plans
    • billing/plans.png
    • billing/payment-method.png
    • billing/invoices.png

Already wired screenshots (in place)

  • Alerts list, Connections empty/add modal, Blueprints empty/import/upload, Dashboard empty state, Auth (sign in/forgot/reset).
  • Quickstart ↔ Connections ↔ Make.com Credentials
  • Import Scenarios ↔ Validate & Fix ↔ Policies ↔ Alerts
  • Settings ↔ Teams & Roles ↔ Billing & Plans
  • Governance (overview) ↔ Telemetry ↔ Policies ↔ Audit Logs ↔ Data Stores (planned)
  • Costs ↔ Billing & Plans

How to Propose / Track Changes​

  • Add new pages under docs/guides/* or docs/getting-started/*.
  • Add screenshot assets under static/img/screenshots/<area>/name.png.
  • When adding placeholders, use pathname://img/... so builds keep passing; replace with /img/... after assets are added.
  • Update this inventory with:
    • Page path
    • One‑line purpose
    • Status (planned/in progress/live)
    • Screenshot status