docs: cover cuga-agent features added in the last 6 months#1
Open
haroldship wants to merge 2 commits into
Open
docs: cover cuga-agent features added in the last 6 months#1haroldship wants to merge 2 commits into
haroldship wants to merge 2 commits into
Conversation
Closes #19.
Adds doc pages for the major cuga-agent features that landed since
the last large docs refresh: Knowledge Base (Docling), Context
Summarization, Evolve integration, Storage backends, Secrets & Vault,
OIDC/BFF Authentication, OpenLit Observability, and UI Branding.
Expands settings-reference.mdx to cover every section currently in
settings.toml ([supervisor], [storage], [policy], [service], [secrets],
[auth], [ui], [context_summarization], [connections], [observability],
[evolve]) and every missing [advanced_features] flag. Updates server
ports and adds env-var subsections for secrets, OIDC, OTel, and
service identity. Removes mem0 references that no longer apply after
cuga-agent PR #153 removed memory support for CUGA classic; the
memory page now opens with a deprecation callout pointing to its
replacements.
Updates the CugaAgent SDK page with the enable_knowledge parameter,
the agent.knowledge namespace, and aclose(). Documents
cuga start demo_supervisor on the CugaSupervisor page.
Also fixes a few minor errors found during the audit:
- Removes a leftover AI-prompt artifact at the bottom of the
architecture overview.
- Fixes the GENT_SETTING_CONFIG typo in the Groq llm-config snippet.
- Replaces the misleading "Selenium/Playwright" tech-stack line with
the actual Playwright + Chromium-extension setup.
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.
Related Issue
Closes #2
Context
Audit of
docsagainstcuga-project/cuga-agent(README, code,src/cuga/settings.toml, and merged PRs over the last ~6 months) identified several major agent capabilities that had no doc coverage and a number of stale entries. This PR closes the gap. Original audit / gap tracking lived in an internal issue; the full plan is reproduced here.Summary
8 new pages under
content/docs/customization/:knowledge.mdx— Docling-powered knowledge base (agent.knowledge,enable_knowledge,cuga start demo_knowledge, scopes, routing through CugaLite).context-summarization.mdx—[context_summarization]config, trigger modes, supervisor support.evolve.mdx—altk-evolveintegration: registry-managed vs standalone SSE, all modes/timeouts.storage.mdx—local(sqlite-vec) vsprod(Postgres + pgvector) backends and embedding providers.secrets-vault.mdx— Local-env vs HashiCorp Vault (token / Kubernetes auth, KV v1/v2, TLS).authentication.mdx— OIDC/BFF auth, role-based authorization, IAM-proxy front-ends,role_token_source.observability.mdx— OpenLit/OTLP observability and the local docker-compose stack.ui-branding.mdx—hide_cuga_logo,brand_namefor white-labelling the demo.Expanded
customization/settings-reference.mdxto mirror the currentsettings.toml:[supervisor],[storage],[storage.embedding],[policy],[service],[secrets],[auth],[ui],[context_summarization],[connections],[observability],[evolve].[advanced_features]flag (force_lite_mode_apps,cuga_lite_max_steps,cuga_lite_bind_tools_*,cuga_lite_nl_auto_continue,cuga_lite_enable_few_shots,enable_todos,reflection_enabled,tool_call_timeout,execution_output_max_length,sub_task_keep_last_n,code_executor_keep_last_n,path_segment_index,force_autonomous_mode,appworld_final_answer_plain).[server_ports](addedfilesystem_mcp,docs_mcp,oak_health_api,demo_server_startup_max_retries; removed deadmemory = 8888).[auth]+ Vault + Postgres + OpenLit.SDK updates
sdk/cuga_agent.mdx— documented the newenable_knowledgeconstructor parameter (defaultTrue), theagent.knowledgeproperty (ingest/search/list_documents, scopes), and the newaclose()resource-cleanup method.sdk/cuga_supervisor.mdx— documentedcuga start demo_supervisor(CRM + email sub-agents demo).Deprecation handling
customization/memory.mdxopens with aCalloutexplaining thatmem0/enable_memory/enable_fact/ thememoryserver port were removed from CUGA classic in cuga-agent PR #153 (2026-04-23). The body is kept as-is for users still on older versions; the callout links to Evolve / Context Summarization / Knowledge as replacements.memory_provider/enable_memory/memory = 8888lines removed fromsettings-reference.mdx(config examples, Dynaconf env vars, troubleshooting tips).Minor errors fixed along the way
architecture-section/overview.mdx("👉 Next step could be to include an inline Mermaid diagram… Want me to add that Mermaid diagram block…?").GENT_SETTING_CONFIG→AGENT_SETTING_CONFIGtypo in the Groq section ofcustomization/llm-config.mdx.Test plan
npm run build— all 76 static pages compile (had to swap two```envfences to```bashbecause this repo's Shiki bundle doesn't includeenv)./docs/customization/memoryshows the deprecation callout at the top./docs/customization/settings-referenceincludes the 11 new section headings./docs/sdk/cuga_agentshowsenable_knowledgein the parameters TypeTable and the new### knowledge/### aclosesections./docs/sdk/cuga_supervisorincludes theTry the Demoblock withcuga start demo_supervisor./docs/architecture-section/overviewends cleanly at the "Performance Monitoring" bullet (no AI-prompt artifact)./docs/getting-started/installationand/docs/getting-started— Quick Start tech-stack accordion no longer mentions Selenium./docs/customization/llm-config— Groq snippet showsAGENT_SETTING_CONFIG.