Skip to content

Add comprehensive documentation for AI agents, file storage, background jobs, and localization#62

Merged
antosubash merged 2 commits intomainfrom
claude/update-docs-4Sgb4
Apr 3, 2026
Merged

Add comprehensive documentation for AI agents, file storage, background jobs, and localization#62
antosubash merged 2 commits intomainfrom
claude/update-docs-4Sgb4

Conversation

@antosubash
Copy link
Copy Markdown
Owner

This PR adds extensive documentation for four major SimpleModule subsystems that were previously undocumented or partially documented.

Summary

Adds four new guide documents and updates configuration/reference documentation to cover AI agents, file storage, background jobs, and localization features. Also updates the project structure guide and testing overview to reflect the expanded framework.

Key Changes

  • New Guide: AI Agents (docs/site/guide/ai-agents.md)

    • Architecture overview (AI providers, agent runtime, RAG pipeline)
    • Setup instructions for Anthropic, OpenAI, Azure OpenAI, and Ollama
    • Agent definition and tool creation patterns
    • Chat API (streaming and non-streaming)
    • RAG integration and configuration
  • New Guide: File Storage (docs/site/guide/file-storage.md)

    • Storage provider interface and implementations (Local, S3, Azure)
    • FileStorage module API endpoints and admin UI
    • Configuration for each provider
    • Contract interface for cross-module file access
    • Provider comparison table
  • New Guide: Background Jobs (docs/site/guide/background-jobs.md)

    • Job definition and registration patterns
    • Job scheduling (immediate, delayed, recurring CRON)
    • Job execution context and state management
    • Admin UI pages and API endpoints
    • Contract interface for querying job data
  • New Guide: Localization (docs/site/guide/localization.md)

    • Locale file structure and embedding as resources
    • React useTranslation hook usage with parameter interpolation
    • Type-safe translation keys pattern
    • Locale resolution priority (user setting → Accept-Language → config default)
    • Backend integration with IStringLocalizer
    • Contract interface for programmatic access
  • Updated Configuration Reference (docs/site/reference/configuration.md)

    • AI provider configuration sections (Anthropic, OpenAI, Azure OpenAI, Ollama)
    • Agent runtime configuration table
    • RAG configuration options
    • File storage provider configurations (Local, S3, Azure)
    • Localization configuration
  • Updated Project Structure (docs/site/getting-started/project-structure.md)

    • Added all new framework packages (Agents, AI providers, RAG, Storage)
    • Expanded module list with new built-in modules (BackgroundJobs, FileStorage, Localization, etc.)
    • Descriptions for new framework components
  • Updated Introduction (docs/site/getting-started/introduction.md)

    • Added AI Agents & RAG feature section
    • Added File Storage feature section
    • Added Background Jobs feature section
    • Added Localization feature section
  • Updated Testing Overview (docs/site/testing/overview.md)

    • Added Benchmarks section (BenchmarkDotNet usage)
    • Added Load Tests section (NBomber scenarios and infrastructure)
  • Updated E2E Tests (docs/site/testing/e2e-tests.md)

    • Expanded page object structure with new admin, audit-logs, background-jobs, marketplace, tenants, and users pages
  • Updated VitePress Config (docs/site/.vitepress/config.ts)

    • Added "Infrastructure" section to sidebar with Background Jobs and File Storage links
    • Added AI Agents and Localization to appropriate sections
  • Updated Home Page (docs/site/index.md)

    • Added AI Agents & RAG feature card
    • Added File Storage feature card
    • Added Background Jobs feature card
  • Minor Fix (package.json)

    • Made husky prepare script non-fatal with || true to prevent installation failures

Notable Implementation Details

  • All new guides follow the existing documentation structure with outline, code examples, configuration tables, and "Next Steps" sections
  • Configuration documentation includes environment variable hints for production secrets
  • API endpoint tables include HTTP method, route, required permission, and description
  • Each guide includes contract interfaces for cross-module integration
  • Examples use realistic scenarios (ProductAssistant, GenerateReportJob, etc.)
  • Documentation covers both setup and usage patterns for developers

https://claude.ai/code/session_01UVf6JAGM85R65Td6mmvaJ1

claude added 2 commits April 3, 2026 10:23
…calization

Add four new guide pages covering major features added since the initial
documentation: AI agents & RAG, background jobs, file storage, and
localization. Update existing pages to reflect the current state of the
framework including new modules, framework packages, configuration
options, testing infrastructure, and E2E page objects.
Cloudflare Pages builds fail during npm install because the husky
prepare script exits non-zero when no .git directory is present.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying simplemodule-website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 38b836c
Status: ✅  Deploy successful!
Preview URL: https://dee49579.simplemodule-website.pages.dev
Branch Preview URL: https://claude-update-docs-4sgb4.simplemodule-website.pages.dev

View logs

@antosubash antosubash enabled auto-merge (squash) April 3, 2026 10:24
@antosubash antosubash merged commit ded11c2 into main Apr 3, 2026
3 of 4 checks passed
@antosubash antosubash deleted the claude/update-docs-4Sgb4 branch April 3, 2026 10:27
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.

2 participants