Flude Docs

Appearance

Flude v2.0 Documentation Map ​

Audience: everyone — the canonical entry point into this documentation set. Every other page links back here.

Flude (Fast Layered Universal Document Engine) turns Doxygen-commented C++/C#/Java/Python source into API documentation — either standalone static HTML or Hugo Markdown for a combined portal.

Pick the section that matches what you're trying to do:

Getting Started ​

New to Flude, or setting up a local environment for the first time.

  • Getting Started — the real Collect → Parse → Render pipeline, and a verified first run against the repository's own mock example project.
  • Environment Requirements — the consolidated Python/Doxygen/Hugo checklist.
  • Target Configurations — the three config layers (global/SDK/doc), walked through against the mock example.

Production Workflow ​

Generating (or browsing) documentation for the real ODA SDKs, not the mock example.

  • Production Workflow — running the real pipeline from inside this repository (ude_projects/<SDK>/generate_all.bat, etc.).
  • Adding a New SDK — step by step, for a new SDK or a new language variant of an existing one.
  • Reader's Guide — for someone who only wants to read an already-built site.

Configuration Reference ​

Looking up exactly what a config key does.

  • Global Settings — ude_global_config.json / GlobalConfig.
  • Target Settings — ude_doc_config.json, and the global → SDK → doc cascade.
  • Sidebar & Groups — the complete sidebar.toml reference: [[sidebar]] and [groups], both mandatory, neither part of the JSON cascade.

CLI & Standards ​

Running ude.cli directly, or writing doc comments Flude will parse correctly.

Architecture & Operations ​

Understanding how the pieces fit together, or running this in CI.

  • Architecture — the two-phase model: content generation, then a separate, later Hugo site build.
  • Troubleshooting — known failure scenarios, including cache/log diagnostics.
  • Admin Deployment — CI/CD deployment mechanics for a single repository.
  • Deployment Reference — the wider CI/CD pipeline matrix and the secrets it depends on.
  • Case Study (Dogfooding) — how this portal's own API reference is built by Flude compiling its own source.

Appendices ​

Copyright © 2026 Fast Layered Universal Document Engine (Flude). Email me!