toolup-forgetoolup-forge
GitHub

Documentation

Every architectural area of toolup-forge — platform, AI, RAG, knowledge base, forms, scheduling, companions, design canon, migrations.

The full documentation tree, synced from toolup-forge/docs/ on every site deploy. The forge repository is the source of truth — if a doc here looks wrong, the fix lands in toolup-forge and propagates on the next deploy.

Platform

The core SDK — composition, scope resolution, modules, infrastructure interfaces.

  • Architecture — three-tier package shape, composition roots, the infrastructure / domain split.
  • Composition roots — ServerApp / AIServerApp / RAGServerApp pipelines.
  • Modules — the 4-file module convention, ClientModule, ServerModule, data types.
  • Surfaces — auth posture, anonymous vs individual vs team vs multi-team.
  • Auth — IAuthProvider, OIDC, registry pattern, multi-team session.
  • Storage — IBlobStorage, IEntityStore, scope-aware persistence.
  • Jobs — IJobScheduler, IJobStore, distributed-ready handler contract.
  • Events — IEventStore, audit replication, retention policy.
  • Portability rules — the six rules every distributed-implementation interface obeys.
  • SSE deployment — server-sent events through proxies / load balancers.
  • Prerender — static-site generation from the Fable client.
  • Premium — tier gating, claim-based feature flags.
  • Surfaces — testing conventions — Expecto over dotnet test, contract test packs.
  • Client logging — ILogger on the Fable side.
  • Client remoting proxies — the per-module proxy pattern.
  • SVG helpers — Feliz SVG primitives.
  • Ads + AdSense — IAdSurface, AdSense approval requirements.
  • Data subject requests — GDPR-shaped erasure / export.

AI

ToolUp.AI — agent loop, SSE streaming, tool registry, system-prompt composition. Built on the IAIProvider extension point.

RAG

ToolUp.RAG — chunking, vector store, retrieval pipeline, ingestion + reembedding background services, prompt builder. Built on IEmbeddingProvider + IVectorStore + IRetrievalPipeline.

Knowledge Base

ToolUp.KnowledgeBase — the canonical user-facing consumer of ToolUp.RAG. Document upload, multi-format extraction (PDF / PPTX / DOCX / XLSX / CSV), ingestion-status surfacing, narrative-commit, notes, AI-context.

Forms

ToolUp.Forms — schema-driven forms, workflows, publishable surveys with HMAC-signed share tokens.

Scheduling

ToolUp.Scheduling — booking with per-resource concurrency lock, recurrence expander, iCalendar serialisation.

Companions

Provider companions sit behind SDK interfaces. Drop in the ones a deployment needs; skip the ones it doesn't.

Or browse the full companion catalogue with NuGet + source links per entry.

Design canon

  • Mixed-mode platform — how Anonymous / Authenticated-Ephemeral / Individual / Team / Multi-Team modes share infrastructure without dragging weight into the surfaces that don't use them.

Migrations

When a release ships a consumer-facing breaking change, a migration doc lands under docs/migrations/ with before/after, verification steps, and rollback. The latest:

The complete list is at docs/migrations/.

Where to ask