Skip to content

Cld2labs/Docugen-Microagents: chore: fix obsolete env vars, health route, model example, and unused ports in Docugen-Microagents docs - #122

Merged
alexsin368 merged 1 commit into
opea-project:mainfrom
cld2labs:cld2labs/Docugen-Microagents
Aug 7, 2026
Merged

Cld2labs/Docugen-Microagents: chore: fix obsolete env vars, health route, model example, and unused ports in Docugen-Microagents docs#122
alexsin368 merged 1 commit into
opea-project:mainfrom
cld2labs:cld2labs/Docugen-Microagents

Conversation

@gopal-raj-suresh

Copy link
Copy Markdown
Contributor

Summary

The DocuGen Micro-Agents docs referenced variables, routes, and a model that no longer match the shipped code. This aligns them with the current .env.example, docker-compose.yml, and api/server.py.

Fixes

1. Obsolete auth variablesTROUBLESHOOTING.md, docs/GENERIC_USAGE.md referenced AUTH_MODE, GENAI_GATEWAY_*, KEYCLOAK_*, BASE_URL, none of which exist in .env.example. Replaced with INFERENCE_API_ENDPOINT/INFERENCE_API_TOKEN.

2. Health routeTROUBLESHOOTING.md used curl .../api/health; the actual route (api/server.py) and compose healthcheck use /health. Fixed.

3. Model example — README's APISIX URL example used Llama-3.1-8B-Instruct, contradicting the validated model (Qwen/Qwen3-4B-Instruct-2507) documented elsewhere in the same file. Corrected.

4. Unused portsBACKEND_PORT/FRONTEND_PORT in .env.example are read by nothing; ports are hardcoded to 5001/3000 in docker-compose.yml, config.py, and vite.config.js. Removed.

Also: container names → Docugen-Microagents-* (matching compose), and docker-composedocker compose (v2).

Scope

Documentation and .env.example only — no code changes.

… ports in docs

Signed-off-by: gopal-raj-suresh <gopal.raj.dummugudupu@cloud2labs.com>
@gopal-raj-suresh
gopal-raj-suresh force-pushed the cld2labs/Docugen-Microagents branch from 7eae6ad to 1c5d545 Compare July 31, 2026 22:01
@gopal-raj-suresh gopal-raj-suresh changed the title chore: fix obsolete env vars, health route, model example, and unused ports in Docugen-Microagents docs Cld2labs/Docugen-Microagents: chore: fix obsolete env vars, health route, model example, and unused ports in Docugen-Microagents docs Jul 31, 2026
@alexsin368
alexsin368 self-requested a review August 3, 2026 23:00

@alexsin368 alexsin368 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@AhmedSeemalK AhmedSeemalK left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@alexsin368
alexsin368 merged commit 6872b82 into opea-project:main Aug 7, 2026
1 of 4 checks passed
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.

4 participants