Installer Flow Stories¶
As an installing developer, I want to confirm the installation target location within my repository, because multiple documentation projects may coexist. |
As an installing developer, I want to select which epics (use-case collections) are activated for the installed agent family, so that I can exclude epics that require custom implementation — for example, a project-specific branching strategy. |
As a ubFlow developer, I want to group flow stories into epics so that epics serve as coarse-grained interaction units during the installation dialogue. |
As an installing developer, I want the installation process to be deterministic and its output to be verifiable against the installation specification, so that I can confirm the installation is complete and matches the requested configuration. |
As an installing developer, I want all installed agent family documentation placed under a single target folder (with optional sub-folders and files), so that the documentation can be relocated as a unit and reviewed in one place. |
As an installing developer, I want to select the agent family template and its version before installation, so that I have full control over which template revision is deployed and can reproduce the same installation at a later point. |
As an installing developer, I want to select a subset of agents from the chosen family for installation, so that I can omit agents that are not relevant to my project and keep the installed documentation lean. |
As an installing developer, I want the installer to verify all required tools and dependencies (e.g. sphinx-needs, ubproject.toml) before starting, and to offer automatic installation of any missing prerequisites, so that the target environment is ready before any files are written. |
As an installing developer, I want to upgrade an existing installation to a newer template version, so that I can adopt improvements and fixes without manually merging changes into the installed documentation. |
As an installing developer, I want the installer to detect conflicts — such as duplicate need IDs or file path collisions — with content already present in the target repository, and report them before writing any files, so that existing work is not silently overwritten. |
As an installing developer, I want to uninstall a previously installed agent family or roll back a failed installation, so that the repository is returned to its prior state without manual cleanup. |
As an installing developer, I want the installer to persist the chosen configuration (template, version, selected agents, target path, activated epics) to an answers file, so that the same installation can be reproduced or updated without re-entering all parameters. |
As an installing developer, I want the installer to run automated validation after completing the installation — including RST syntax checks and a Sphinx build — so that I receive an immediate confirmation that the installed documentation is well-formed and buildable. |
As an installing developer, I want agent-family packages to be available locally — as a directory or zip bundled with the ubCode VS Code extension, or as a directory directly in the repository — so that installation works offline and I never depend on network access to a remote git repository. |
As a package author, I want to declare package metadata, the set of
installable directories, and the available epics in a |
As a developer, I want the installer to detect an existing
|
ubFlow Agent Stub¶
As a developer, I want the installer to automatically create the ubFlow
agent stub file ( |
As a developer installing a ubFlow agent family, I want the installer to
automatically create a |