Skip to content

docs: README badges + trim, complete ingestion formats, re-orient dev-heavy pages

Jérôme Revillard requested to merge docs/readme-badges-reorient into main

Follow-up to !219 (merged) (docs review). Three improvements:

README.md (377 → 254 lines)

  • Badges: pipeline, coverage, license (Apache-2.0), DPG-aligned, OSI Open Source AI, docs — GitLab badge SVGs verified.
  • Concise intro: one-paragraph "what is GENIE.AI" replacing the wall of text.
  • Deduped: "Core characteristics" was repeated verbatim — kept once.
  • Accuracy fixes: "optimized for Kubernetes" → Docker Swarm (the actual deployment); placeholder github.com clone URL → real GitLab remote.
  • Consolidated the repeated documentation-link sections into one table mapping each docs section to its audience.

knowledge-base/ingestion.md — supported formats (live accuracy fix)

The table listed only PDF/DOCX/XLSX. Now complete + accurate per document-repository/src/config/appConfig.js: PDF, DOC/DOCX, XLS/XLSX, Markdown, plain text, HTML (+ ZIP MIME fallback for Office uploads). Added a pointer to the authoritative source file.

Dev-heavy pages re-oriented

Stripped leaked scan-dump metadata (generated dates, absolute /home/jerome/... paths, Project/Framework/Location blocks) from source-tree-analysis, integration-architecture, and both UI-component-inventory pages — so they read as clean developer reference, not internal AI-scan output. (Audience framing for each was added in !219 (merged)'s front-matter descriptions.)

Build verified clean locally.

Merge request reports