Skip to content

[draft] bfabric-app-runner docs#433

Closed
leoschwarz wants to merge 1 commit intomainfrom
docs-app-runner
Closed

[draft] bfabric-app-runner docs#433
leoschwarz wants to merge 1 commit intomainfrom
docs-app-runner

Conversation

@leoschwarz
Copy link
Copy Markdown
Member

there were some earlier efforst in #220 which should be merged into this branch as well

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 11, 2026

📝 "TODO" Changes Detected

Summary: ➕ 1 "TODO" added

➕ Added "TODO"s (1)

  • bfabric_app_runner/docs/api_reference/specs/output_specification.md:49: - The workunit ID needs to be specified, so the correct information can be retrieved. (TODO but instead of the workunit id it should also be possible to pass the ref)

This comment is automatically updated when "TODO" changes are detected.

leoschwarz added a commit that referenced this pull request Apr 13, 2026
Consolidate documentation from PRs #220 and #433 into a new structured
docs layout following the bfabric core docs pattern.

New sections:
- getting_started/: installation, quick start (Makefile workflow), configuration
- user_guides/: deploying apps, creating apps, inputs, outputs, CLI reference,
  Python environments
- api_reference/: autodoc index for key specs and models
- resources/: links to changelog, repo, and bfabricPy docs

Updated:
- conf.py: sphinx_book_theme, MyST extensions, autodoc_pydantic
- architecture/overview.md: narrative text for workflow phases and components
- specs/app_specification.md: added CommandShell and CommandPythonEnv sections
- specs/output_specification.md: added bfabric_link example, fixed CLI usage
@leoschwarz leoschwarz closed this Apr 13, 2026
@leoschwarz leoschwarz deleted the docs-app-runner branch April 13, 2026 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant