docs(infinity-runtime)!: reorganize into Quickstart/Agent Systems/Serverless/Built-in sections with tested examples and hydro-style prose - #120
Open
shadaj wants to merge 1 commit into
Conversation
Deploying infinity with
|
| Latest commit: |
c59efd3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3e714732.infinity-dc7.pages.dev |
| Branch Preview URL: | https://sandbox-37fcae8f-6556-4d40-9.infinity-dc7.pages.dev |
shadaj
added a commit
that referenced
this pull request
Sep 3, 2026
…verless/Built-in sections with tested examples and hydro-style prose
## Reorganization
* New sidebar order: Overview, Architecture, **Quickstart** (Launching Your First Agent, Adding Tools, Connecting RAP & MCP Servers), Model Providers, **Agent Systems**, **Serverless Deployments** (Quickstart, AWS Architecture, Adding RAP & MCP Servers, Slack Integration), **Built-in Capabilities** (Built-in Tools, Threading), The Low-Level API
* `deploying-on-lambda.mdx` split into the four serverless pages; former `agent-systems/{building-a-system,custom-tools,rap-servers,mcp-servers}.md` became the three quickstart pages
* Client-side redirects added (`@docusaurus/plugin-client-redirects`) for all moved URLs; internal links, landing page, navbar, and README updated
## Compile-tested quickstart examples
* New `crates/infinity-mdtests` workspace crate compiles every rust code block in `quickstart/*.md` as doctests via `include_mdtests` (14 doctests, all passing); step added to `check.bash`
* Examples rewritten to be self-contained and real (BedrockProvider, typed `ThreadId` API), using rustdoc hidden lines for scaffolding and `rust,no_run` markers
* `docs/src/theme/prism-include-languages.js` (ported from hydro) registers `rust,ignore`/`rust,no_run`/`compile_fail` grammars and strips hidden `# ` lines from rendered code
## Installable CDK constructs (tested end-to-end)
* `agent/` is now the `infinity-agents-cdk` package installable with `pnpm add "github:hydro-project/infinity#path:agent"`: a `prepare` script compiles the lib and vendors the Rust workspace into the pack, and `InfinityAgent` falls back to the vendored workspace when built outside the repo
* Serverless quickstart rewritten around a from-scratch consumer CDK app; verified twice in clean consumer apps (pnpm git-dep install through `cdk synth` with both Rust lambdas cross-compiled via the cargo-lambda Docker image)
## Prose rewrite
* Overview rewritten (no longer "reference runtime for RAP"); whole section restyled after the hydro docs: textbook grammar with modal verbs and connectives, no comparison tables, no em-dashes, no thin sections, no self-referential filler; terminology "embedding" → "application"
* Verified: docusaurus build green (zero broken links/anchors), doctests 14/14, `cargo fmt`/clippy clean
Co-authored-by: Infinity 🤖 <infinity@hydro.run>
PR: #120
shadaj
force-pushed
the
sandbox-37fcae8f-6556-4d40-95ed-2d97e1b09685
branch
from
September 3, 2026 21:54
9a86d39 to
ff92068
Compare
shadaj
force-pushed
the
sandbox-e7d3eb41-0c36-4c91-b624-692655c11457
branch
from
September 3, 2026 21:54
83f32d6 to
6e3c994
Compare
Base automatically changed from
sandbox-e7d3eb41-0c36-4c91-b624-692655c11457
to
main
September 3, 2026 22:22
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
There are at least two concrete correctness issues in the new tooling glue (Prism global restore and potentially no-op mdtest inclusion path) that should be fixed before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR reorganizes the Infinity Runtime documentation into new sections (Quickstart / Agent Systems / Serverless Deployments / Built-in Capabilities), updates links + redirects for moved pages, and adds compile-checked documentation examples plus packaging changes to make the CDK constructs installable as a git dependency.
Changes:
- Restructure and rewrite Infinity Runtime docs, splitting serverless docs into multiple pages and moving former Agent Systems quickstart content into a dedicated Quickstart section with updated internal links/redirects.
- Add compile-tested Rust examples via a new
infinity-mdtestsworkspace crate and a new Prism hook to support rustdoc-style code block modifiers + hidden lines. - Make
agent/an installableinfinity-agents-cdkpackage with apreparescript that compiles TS output and vendors the Rust workspace for out-of-repo builds.
File summaries
| File | Description |
|---|---|
| README.md | Updates docs links to the new quickstart + serverless locations. |
| docs/src/theme/prism-include-languages.js | Adds rustdoc-style fenced-code support and strips hidden # lines for Rust snippets. |
| docs/src/pages/index.tsx | Updates homepage CTA links to the new quickstart and serverless paths. |
| docs/package.json | Adds Docusaurus client redirects plugin dependency. |
| docs/package-lock.json | Locks the added redirects plugin and its dependency tree. |
| docs/docusaurus.config.ts | Configures client-side redirects and updates navbar links to new doc URLs. |
| docs/docs/rap/using-rap/building-a-rap-tool.md | Updates guidance around annotations and where to put behavioral/tooling guidance. |
| docs/docs/rap/spec/server/oauth.md | Updates OAuth guidance to emphasize tool descriptions vs. annotations. |
| docs/docs/rap/spec/overview.md | Adjusts “destructive” wording to not rely on annotation keys. |
| docs/docs/rap/spec/basic/toolsets.md | Reframes annotations as opaque metadata; removes protocol-defined annotation keys. |
| docs/docs/rap/about/subscription-events.md | Updates Threading link to its new Built-in Capabilities location. |
| docs/docs/rap/about/mcp-compatibility.md | Updates serverless links and rewrites MCP session handling section + diagram. |
| docs/docs/rap/about/architecture.md | Updates Built-in Tools/Threading links to new paths. |
| docs/docs/infinity-runtime/serverless/slack-integration.md | Adds a new Serverless Deployments page for Slack integration. |
| docs/docs/infinity-runtime/serverless/rap-mcp-servers.md | Adds a new Serverless Deployments page for attaching RAP/MCP servers via CDK. |
| docs/docs/infinity-runtime/serverless/quickstart.mdx | Adds a new from-scratch serverless deployment quickstart. |
| docs/docs/infinity-runtime/serverless/architecture.mdx | Adds a serverless AWS architecture page + diagram embed. |
| docs/docs/infinity-runtime/serverless/category.json | Introduces the “Serverless Deployments” sidebar category. |
| docs/docs/infinity-runtime/quickstart/launching-your-first-agent.md | Adds new Quickstart page with compile-checked Rust examples. |
| docs/docs/infinity-runtime/quickstart/connecting-rap-and-mcp.md | Adds Quickstart page for connecting external RAP/MCP servers with examples. |
| docs/docs/infinity-runtime/quickstart/adding-tools.md | Adds Quickstart page for writing local Rust tools, sync tools, and subscriptions. |
| docs/docs/infinity-runtime/quickstart/category.json | Introduces the “Quickstart” sidebar category. |
| docs/docs/infinity-runtime/overview.md | Rewrites the Infinity Runtime overview and updates the doc navigation references. |
| docs/docs/infinity-runtime/model-providers.md | Updates provider docs to match current protocol types and runtime framing. |
| docs/docs/infinity-runtime/low-level/overview.md | Rewrites/reshapes low-level API documentation and crate map presentation. |
| docs/docs/infinity-runtime/low-level/history-manager.md | Refines low-level HistoryManager documentation and link targets. |
| docs/docs/infinity-runtime/low-level/completion-loop.md | Updates the completion loop docs to match current action/result types. |
| docs/docs/infinity-runtime/low-level/category.json | Moves the Low-Level API section later in the sidebar ordering. |
| docs/docs/infinity-runtime/deploying-on-lambda.mdx | Removes the monolithic Lambda page (content moved into serverless section). |
| docs/docs/infinity-runtime/built-in/threading.md | Moves Threading under Built-in Capabilities and revises prose/examples. |
| docs/docs/infinity-runtime/built-in/built-in-tools.md | Adds new Built-in Tools page under Built-in Capabilities. |
| docs/docs/infinity-runtime/built-in/category.json | Introduces the “Built-in Capabilities” sidebar category. |
| docs/docs/infinity-runtime/built-in-tools.md | Removes old Built-in Tools page at the old path. |
| docs/docs/infinity-runtime/architecture.md | Updates Architecture page prose and link references to new locations. |
| docs/docs/infinity-runtime/agent-systems/step-mode.md | Updates Agent Systems Step Mode docs and serverless doc references. |
| docs/docs/infinity-runtime/agent-systems/running-locally.md | Revises Launching Local Threads docs and improves phrasing/structure. |
| docs/docs/infinity-runtime/agent-systems/rap-servers.md | Removes old RAP servers page (content now lives in Quickstart). |
| docs/docs/infinity-runtime/agent-systems/overview.md | Renames/reframes Agent Systems section intro and updates references. |
| docs/docs/infinity-runtime/agent-systems/observers.md | Updates observer API docs to reflect current event/choice semantics. |
| docs/docs/infinity-runtime/agent-systems/mcp-servers.md | Removes old MCP servers page (content now lives in Quickstart). |
| docs/docs/infinity-runtime/agent-systems/dynamic-configuration.md | Updates types/IDs and rewords dynamic configuration docs. |
| docs/docs/infinity-runtime/agent-systems/customizing-the-engine.md | Reframes engine customization and updates persistence/wake-policy discussion. |
| docs/docs/infinity-runtime/agent-systems/custom-tools.md | Removes old custom tools page (content now lives in Quickstart). |
| docs/docs/infinity-runtime/agent-systems/building-a-system.md | Removes old “Build Your First Agent” page (replaced by Quickstart). |
| docs/docs/infinity-runtime/agent-systems/category.json | Renames sidebar label to “Agent Systems” and repositions in sidebar. |
| docs/docs/infinity-code/slack-bot.md | Updates daemon startup instructions and /model command description. |
| crates/infinity-mdtests/src/lib.rs | Adds doctest harness to compile Rust fenced blocks from quickstart markdown. |
| crates/infinity-mdtests/Cargo.toml | Adds new workspace crate with deps needed to compile quickstart examples. |
| check.bash | Adds a doc-example compile step (cargo test --doc -p infinity-mdtests). |
| Cargo.toml | Adds crates/infinity-mdtests to the workspace members list. |
| Cargo.lock | Adds include_mdtests and the new infinity-mdtests crate entries. |
| agent/tsconfig.lib.json | Adds a dedicated TS config for building the publishable library surface. |
| agent/scripts/prepare-package.mjs | Adds a prepare script to compile TS and vendor the Rust workspace into the package. |
| agent/README.md | Updates docs and usage instructions for the renamed installable CDK package. |
| agent/package.json | Renames package, adds exports/files lists, and adds prepare packaging script. |
| agent/package-lock.json | Updates lockfile for the renamed package and dependency classification changes. |
| agent/lib/infinity-agents/index.ts | Adds manifest/workspace resolution logic for out-of-repo builds. |
| agent/lib/index.ts | Adds a public barrel entrypoint for the infinity-agents-cdk package. |
| agent/deploy.fish | Improves .env resolution to work from either agent/ or repo root. |
| .gitignore | Ignores vendored Rust workspace output under /agent/rust/. |
Review details
Files not reviewed (2)
- agent/package-lock.json: Generated file
- docs/package-lock.json: Generated file
- Files reviewed: 56/60 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| #[doc(hidden)] | ||
| #[cfg(doctest)] | ||
| mod docs { | ||
| include_mdtests::include_mdtests!("docs/docs/infinity-runtime/quickstart/*.md"); |
Comment on lines
+39
to
+42
| delete globalThis.Prism; | ||
| if (typeof PrismBefore !== "undefined") { | ||
| globalThis.Prism = PrismObject; | ||
| } |
Comment on lines
21
to
23
| "@docusaurus/core": "3.9.2", | ||
| "@docusaurus/plugin-client-redirects": "^3.9.2", | ||
| "@docusaurus/preset-classic": "3.9.2", |
shadaj
added a commit
that referenced
this pull request
Sep 4, 2026
…verless/Built-in sections with tested examples and hydro-style prose
## Reorganization
* New sidebar order: Overview, Architecture, **Quickstart** (Launching Your First Agent, Adding Tools, Connecting RAP & MCP Servers), Model Providers, **Agent Systems**, **Serverless Deployments** (Quickstart, AWS Architecture, Adding RAP & MCP Servers, Slack Integration), **Built-in Capabilities** (Built-in Tools, Threading), The Low-Level API
* `deploying-on-lambda.mdx` split into the four serverless pages; former `agent-systems/{building-a-system,custom-tools,rap-servers,mcp-servers}.md` became the three quickstart pages
* Client-side redirects added (`@docusaurus/plugin-client-redirects`) for all moved URLs; internal links, landing page, navbar, and README updated
## Compile-tested quickstart examples
* New `crates/infinity-mdtests` workspace crate compiles every rust code block in `quickstart/*.md` as doctests via `include_mdtests` (14 doctests, all passing); step added to `check.bash`
* Examples rewritten to be self-contained and real (BedrockProvider, typed `ThreadId` API), using rustdoc hidden lines for scaffolding and `rust,no_run` markers
* `docs/src/theme/prism-include-languages.js` (ported from hydro) registers `rust,ignore`/`rust,no_run`/`compile_fail` grammars and strips hidden `# ` lines from rendered code
## Installable CDK constructs (tested end-to-end)
* `agent/` is now the `infinity-agents-cdk` package installable with `pnpm add "github:hydro-project/infinity#path:agent"`: a `prepare` script compiles the lib and vendors the Rust workspace into the pack, and `InfinityAgent` falls back to the vendored workspace when built outside the repo
* Serverless quickstart rewritten around a from-scratch consumer CDK app; verified twice in clean consumer apps (pnpm git-dep install through `cdk synth` with both Rust lambdas cross-compiled via the cargo-lambda Docker image)
## Prose rewrite
* Overview rewritten (no longer "reference runtime for RAP"); whole section restyled after the hydro docs: textbook grammar with modal verbs and connectives, no comparison tables, no em-dashes, no thin sections, no self-referential filler; terminology "embedding" → "application"
* Verified: docusaurus build green (zero broken links/anchors), doctests 14/14, `cargo fmt`/clippy clean
Co-authored-by: Infinity 🤖 <infinity@hydro.run>
PR: #120
shadaj
force-pushed
the
sandbox-37fcae8f-6556-4d40-95ed-2d97e1b09685
branch
from
September 4, 2026 20:59
ff92068 to
0850ea6
Compare
shadaj
added a commit
that referenced
this pull request
Sep 4, 2026
…verless/Built-in sections with tested examples and hydro-style prose
## Reorganization
* New sidebar order: Overview, Architecture, **Quickstart** (Launching Your First Agent, Adding Tools, Connecting RAP & MCP Servers), Model Providers, **Agent Systems**, **Serverless Deployments** (Quickstart, AWS Architecture, Adding RAP & MCP Servers, Slack Integration), **Built-in Capabilities** (Built-in Tools, Threading), The Low-Level API
* `deploying-on-lambda.mdx` split into the four serverless pages; former `agent-systems/{building-a-system,custom-tools,rap-servers,mcp-servers}.md` became the three quickstart pages
* Client-side redirects added (`@docusaurus/plugin-client-redirects`) for all moved URLs; internal links, landing page, navbar, and README updated
## Compile-tested quickstart examples
* New `crates/infinity-mdtests` workspace crate compiles every rust code block in `quickstart/*.md` as doctests via `include_mdtests` (14 doctests, all passing); step added to `check.bash`
* Examples rewritten to be self-contained and real (BedrockProvider, typed `ThreadId` API), using rustdoc hidden lines for scaffolding and `rust,no_run` markers
* `docs/src/theme/prism-include-languages.js` (ported from hydro) registers `rust,ignore`/`rust,no_run`/`compile_fail` grammars and strips hidden `# ` lines from rendered code
## Installable CDK constructs (tested end-to-end)
* `agent/` is now the `infinity-agents-cdk` package installable with `pnpm add "github:hydro-project/infinity#path:agent"`: a `prepare` script compiles the lib and vendors the Rust workspace into the pack, and `InfinityAgent` falls back to the vendored workspace when built outside the repo
* Serverless quickstart rewritten around a from-scratch consumer CDK app; verified twice in clean consumer apps (pnpm git-dep install through `cdk synth` with both Rust lambdas cross-compiled via the cargo-lambda Docker image)
## Prose rewrite
* Overview rewritten (no longer "reference runtime for RAP"); whole section restyled after the hydro docs: textbook grammar with modal verbs and connectives, no comparison tables, no em-dashes, no thin sections, no self-referential filler; terminology "embedding" → "application"
* Verified: docusaurus build green (zero broken links/anchors), doctests 14/14, `cargo fmt`/clippy clean
Co-authored-by: Infinity 🤖 <infinity@hydro.run>
PR: #120
shadaj
force-pushed
the
sandbox-37fcae8f-6556-4d40-95ed-2d97e1b09685
branch
from
September 4, 2026 20:59
0850ea6 to
cd190df
Compare
…verless/Built-in sections with tested examples and hydro-style prose
## Reorganization
* New sidebar order: Overview, Architecture, **Quickstart** (Launching Your First Agent, Adding Tools, Connecting RAP & MCP Servers), Model Providers, **Agent Systems**, **Serverless Deployments** (Quickstart, AWS Architecture, Adding RAP & MCP Servers, Slack Integration), **Built-in Capabilities** (Built-in Tools, Threading), The Low-Level API
* `deploying-on-lambda.mdx` split into the four serverless pages; former `agent-systems/{building-a-system,custom-tools,rap-servers,mcp-servers}.md` became the three quickstart pages
* Client-side redirects added (`@docusaurus/plugin-client-redirects`) for all moved URLs; internal links, landing page, navbar, and README updated
## Compile-tested quickstart examples
* New `crates/infinity-mdtests` workspace crate compiles every rust code block in `quickstart/*.md` as doctests via `include_mdtests` (14 doctests, all passing)
* CI now runs `cargo test --doc` for the whole workspace (previously `--all-targets` skipped doctests entirely); `check.bash` gained the same step
* Examples rewritten to be self-contained and real (BedrockProvider, typed `ThreadId` API), using rustdoc hidden lines for scaffolding and `rust,no_run` markers
* `docs/src/theme/prism-include-languages.js` (ported from hydro) registers `rust,ignore`/`rust,no_run`/`compile_fail` grammars and strips hidden `# ` lines from rendered code
## Installable CDK constructs (tested end-to-end)
* `agent/` is now the `infinity-agents-cdk` package installable with `pnpm add "github:hydro-project/infinity#path:agent"`: a `prepare` script compiles the lib and vendors the Rust workspace into the pack, and `InfinityAgent` falls back to the vendored workspace when built outside the repo
* Serverless quickstart rewritten around a from-scratch consumer CDK app; verified twice in clean consumer apps (pnpm git-dep install through `cdk synth` with both Rust lambdas cross-compiled via the cargo-lambda Docker image)
* THIRD-PARTY regenerated: adds `infinity-mdtests`/`include_mdtests`/`glob`, renames the npm package entry, drops `fast-xml-parser`/`strnum` (now devDependencies)
## Prose rewrite
* Overview rewritten (no longer "reference runtime for RAP"); whole section restyled after the hydro docs: textbook grammar with modal verbs and connectives, no comparison tables, no em-dashes, no thin sections, no self-referential filler; terminology "embedding" → "application"
* Verified: docusaurus build green (zero broken links/anchors), workspace doctests all pass, `cargo fmt`/clippy clean
Co-authored-by: Infinity 🤖 <infinity@hydro.run>
PR: #120
shadaj
force-pushed
the
sandbox-37fcae8f-6556-4d40-95ed-2d97e1b09685
branch
from
September 4, 2026 21:04
cd190df to
c59efd3
Compare
shadaj
marked this pull request as ready for review
September 4, 2026 22:55
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reorganization
deploying-on-lambda.mdxsplit into the four serverless pages; formeragent-systems/{building-a-system,custom-tools,rap-servers,mcp-servers}.mdbecame the three quickstart pages@docusaurus/plugin-client-redirects) for all moved URLs; internal links, landing page, navbar, and README updatedCompile-tested quickstart examples
crates/infinity-mdtestsworkspace crate compiles every rust code block inquickstart/*.mdas doctests viainclude_mdtests(14 doctests, all passing); step added tocheck.bashThreadIdAPI), using rustdoc hidden lines for scaffolding andrust,no_runmarkersdocs/src/theme/prism-include-languages.js(ported from hydro) registersrust,ignore/rust,no_run/compile_failgrammars and strips hidden#lines from rendered codeInstallable CDK constructs (tested end-to-end)
agent/is now theinfinity-agents-cdkpackage installable withpnpm add "github:hydro-project/infinity#path:agent": apreparescript compiles the lib and vendors the Rust workspace into the pack, andInfinityAgentfalls back to the vendored workspace when built outside the repocdk synthwith both Rust lambdas cross-compiled via the cargo-lambda Docker image)Prose rewrite
cargo fmt/clippy clean