From 572026a7df73edce8fd09a66e2a65ba7cb9cbf31 Mon Sep 17 00:00:00 2001 From: Andres Contreras Date: Sat, 24 Oct 2026 02:28:11 -0700 Subject: [PATCH] docs: direct standalone users to native pyfly Agentic --- README.md | 27 +++++++++++++++++++++++++- docs/README.md | 25 +++++++++++++++++++++++- docs/index.md | 7 +++---- docs/migration.md | 19 ++++++++++++++++-- docs/stylesheets/firefly.css | 4 ++++ examples/README.md | 7 +++++++ mkdocs.yml | 7 +++---- overrides/home.html | 37 +++++++++++++++++++++--------------- overrides/main.html | 8 ++++++++ 9 files changed, 114 insertions(+), 27 deletions(-) create mode 100644 overrides/main.html diff --git a/README.md b/README.md index d5a2ee6a..5f0ec8ba 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ +> [!IMPORTANT] +> **Moved to pyfly: `pyfly.agentic`.** Active development continues in +> [fireflyframework-pyfly](https://github.com/fireflyframework/fireflyframework-pyfly), starting with +> [pyfly v26.10.08](https://github.com/fireflyframework/fireflyframework-pyfly/releases/tag/v26.10.08) (package version `26.10.8`). +> Use the [native Agentic documentation](https://fireflyframework.github.io/fireflyframework-pyfly/docs/modules/agentic/) and +> [migration guide](https://fireflyframework.github.io/fireflyframework-pyfly/docs/modules/agentic/migration/). This repository, its releases and the +> standalone documentation below are retained as historical material. +> Replace `fireflyframework_agentic` imports with `pyfly.agentic`, +> `FireflyAgent` with `Agent`, `BaseTool` with `AgentTool`, and +> `@firefly_agent` / `@firefly_tool` with `@agent` / `@agent_tool`. +> The native module provides no aliases for the old namespace or names. + +```bash +python -m pip install "pyfly[agentic] @ https://github.com/fireflyframework/fireflyframework-pyfly/releases/download/v26.10.08/pyfly-26.10.8-py3-none-any.whl" +``` + +Enable `pyfly.agentic.enabled: true` in your pyfly application. Rename +`FIREFLY_AGENTIC_*` settings to `PYFLY_AGENTIC_*` and select namespaced integration +extras such as `agentic-postgres`. Follow the migration guide for configuration, +application-owned runtime services, plugins and persistent data. + +--- + +## Historical standalone project +

agentic by Firefly — Intelligence, composed.

@@ -21,7 +46,7 @@ Type checked: pyright

-Current release: [26.10.1](https://github.com/fireflyframework/fireflyframework-agentic/releases/tag/v26.10.1). +Final standalone release: [26.10.1](https://github.com/fireflyframework/fireflyframework-agentic/releases/tag/v26.10.1). This release refreshes dependencies and preserves PostgreSQL's whole-batch rejection of cross-namespace ID conflicts. Read the [upgrade notes](docs/migration.md#dependency-refresh-in-26101) and diff --git a/docs/README.md b/docs/README.md index 4a02bf54..ece36b75 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,27 @@ -# Firefly Agentic documentation +> [!IMPORTANT] +> **Moved to pyfly: `pyfly.agentic`.** Active development continues in +> [fireflyframework-pyfly](https://github.com/fireflyframework/fireflyframework-pyfly), starting with +> [pyfly v26.10.08](https://github.com/fireflyframework/fireflyframework-pyfly/releases/tag/v26.10.08) (package version `26.10.8`). +> Use the [native Agentic documentation](https://fireflyframework.github.io/fireflyframework-pyfly/docs/modules/agentic/) and +> [migration guide](https://fireflyframework.github.io/fireflyframework-pyfly/docs/modules/agentic/migration/). This repository, its releases and the +> standalone documentation below are retained as historical material. +> Replace `fireflyframework_agentic` imports with `pyfly.agentic`, +> `FireflyAgent` with `Agent`, `BaseTool` with `AgentTool`, and +> `@firefly_agent` / `@firefly_tool` with `@agent` / `@agent_tool`. +> The native module provides no aliases for the old namespace or names. + +```bash +python -m pip install "pyfly[agentic] @ https://github.com/fireflyframework/fireflyframework-pyfly/releases/download/v26.10.08/pyfly-26.10.8-py3-none-any.whl" +``` + +Enable `pyfly.agentic.enabled: true` in your pyfly application. Rename +`FIREFLY_AGENTIC_*` settings to `PYFLY_AGENTIC_*` and select namespaced integration +extras such as `agentic-postgres`. Follow the migration guide for configuration, +application-owned runtime services, plugins and persistent data. + +--- + +# Historical standalone Agentic documentation Start with the [published documentation](https://fireflyframework.github.io/fireflyframework-agentic/) or follow the same guides here on GitHub. diff --git a/docs/index.md b/docs/index.md index bf89d59f..56e17587 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,8 @@ --- -title: Firefly Agentic +title: Agentic moved to pyfly description: >- - The production-grade agentic metaframework, built on Pydantic AI. Build with - Firefly agents, tools and typed model options — gain lifecycle hooks, delegation, - memory, reasoning patterns, validation loops, RAG and DAG pipelines. + Agentic development has moved to pyfly's native pyfly.agentic module. + This site preserves the historical standalone documentation. template: home.html hide: - navigation diff --git a/docs/migration.md b/docs/migration.md index 0404630e..b11128a0 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -2,8 +2,23 @@ Copyright 2026 Firefly Software Foundation. SPDX-License-Identifier: Apache-2.0. -This guide covers the 26.10.1 dependency refresh, PostgreSQL vector-store safety -in 26.10.0, the Pydantic AI 2.x upgrade, and earlier API changes. +## Move to native pyfly Agentic + +Active development has moved to [pyfly](https://github.com/fireflyframework/fireflyframework-pyfly) and the `pyfly.agentic` +namespace, starting with [v26.10.08](https://github.com/fireflyframework/fireflyframework-pyfly/releases/tag/v26.10.08) (package version `26.10.8`). +Follow the [native migration checklist](https://fireflyframework.github.io/fireflyframework-pyfly/docs/modules/agentic/migration/) and +[installation guide](https://fireflyframework.github.io/fireflyframework-pyfly/docs/modules/agentic/getting-started/installation/). + +Replace the standalone distribution with `pyfly[agentic]`; rename imports to +`pyfly.agentic`, `FireflyAgent` to `Agent`, `BaseTool` to `AgentTool`, and +`@firefly_agent` / `@firefly_tool` to `@agent` / `@agent_tool`. +The native module provides no aliases for the old names. Rename settings to +`PYFLY_AGENTIC_*`, enable `pyfly.agentic.enabled`, use namespaced integration extras, +and adopt application-owned runtime services as described in the native guide. + +The rest of this page preserves the historical standalone 26.10.1 dependency +refresh, PostgreSQL vector-store safety in 26.10.0, Pydantic AI 2.x upgrade, and +earlier API changes. These version numbers refer to the standalone distribution. ## Dependency refresh in 26.10.1 diff --git a/docs/stylesheets/firefly.css b/docs/stylesheets/firefly.css index 327b61f0..9fc93cba 100644 --- a/docs/stylesheets/firefly.css +++ b/docs/stylesheets/firefly.css @@ -65,6 +65,10 @@ --md-default-bg-color: #10110f; } +/* The migration announcement has a dark surface in both color schemes. */ +.md-banner a { color: var(--ff-accent-bright); text-decoration: underline; } +.md-banner a:focus-visible { outline: 2px solid var(--ff-accent-bright); outline-offset: 3px; } + /* Display face for all headings, in docs and on the landing. */ .md-typeset h1, .md-typeset h2, diff --git a/examples/README.md b/examples/README.md index ca31eb99..6e58395f 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,3 +1,10 @@ +> [!IMPORTANT] +> This is the historical standalone example catalogue. Native examples now live in +> [pyfly's `examples/agentic`](https://github.com/fireflyframework/fireflyframework-pyfly/tree/main/examples/agentic). +> Install [pyfly v26.10.08](https://github.com/fireflyframework/fireflyframework-pyfly/releases/tag/v26.10.08) or later and follow the +> [migration guide](https://fireflyframework.github.io/fireflyframework-pyfly/docs/modules/agentic/migration/) before adapting an application. +> The setup commands and old API names below describe the standalone release. + # Examples Copyright 2026 Firefly Software Foundation. Licensed under the Apache License 2.0. diff --git a/mkdocs.yml b/mkdocs.yml index 9ea8d31c..c0929124 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,12 +1,11 @@ # Firefly Agentic — documentation site (MkDocs + Material). # Local preview: pip install -r docs/requirements.txt && mkdocs serve # Build (CI): mkdocs build --strict -site_name: Firefly Agentic +site_name: Firefly Agentic (historical) site_url: https://fireflyframework.github.io/fireflyframework-agentic/ site_description: >- - The production-grade agentic metaframework, built on Pydantic AI. Build with - Firefly agents, tools and typed model options — gain lifecycle hooks, delegation, - memory, reasoning patterns, validation loops, RAG and DAG pipelines. + Historical standalone Agentic documentation. Active development has moved to + pyfly's native pyfly.agentic module, starting with pyfly v26.10.08. site_author: Firefly Software Foundation copyright: Copyright © 2026 Firefly Software Foundation — Apache-2.0 diff --git a/overrides/home.html b/overrides/home.html index f4654233..f15db6c9 100644 --- a/overrides/home.html +++ b/overrides/home.html @@ -10,12 +10,12 @@ {% block extrahead %} - + {% endblock %} -{% block htmltitle %}Firefly Agentic — production-grade agents on Pydantic AI{% endblock %} +{% block htmltitle %}Agentic moved to pyfly — historical documentation{% endblock %} {% block tabs %}
@@ -24,34 +24,34 @@
-

Agents you can run in production.

+

Agentic has moved to pyfly.

- Firefly Agentic is the production-grade metaframework built on Pydantic AI. - Use Firefly agents, tools, memory and typed model options — gain - lifecycle hooks, delegation, reasoning patterns, validation loops, RAG - and DAG pipelines. Keep provider choices in configuration and compose the features you need. + Active development continues in pyfly.agentic, the native, + opt-in Agentic module in pyfly v26.10.08 (package version 26.10.8). + Use Agent, AgentTool, @agent and + @agent_tool. The old namespace and public names have no aliases.

$ - curl -fsSL https://raw.githubusercontent.com/fireflyframework/fireflyframework-agentic/main/install.sh | bash -
-

This installer follows main. For a pinned version, install the v26.10.0 release.

+

Install the released pyfly wheel with the agentic extra, then enable pyfly.agentic.enabled. Follow the migration checklist. This site and the standalone releases are retained as historical material.

- - Get started + + Open native Agentic docs - + - Read the tutorial + Migrate to pyfly - + GitHub @@ -59,6 +59,13 @@

Agents you can run in productio

+
+
+

Historical standalone reference

+

The guides, examples and API names below describe the former standalone distribution. Use the native pyfly documentation for current development.

+
+
+
diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 00000000..4d9b2132 --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,8 @@ +{% extends "base.html" %} + +{% block announce %} + Agentic moved to pyfly: pyfly.agentic. + This is historical standalone documentation. + pyfly v26.10.08 · + Migration guide +{% endblock %}