LCORE-533: updated config doc

[tisnik]

Description

LCORE-533: updated config doc

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Tools used to create PR

Identify any AI code assistants used in this PR (for transparency and review context)

• Assisted-by: N/A
• Generated by: N/A

Related Tickets & Documents

• Related Issue #LCORE-533

Summary by CodeRabbit

• Documentation
  • Updated configuration documentation with improved formatting and structure for enhanced readability.
  • Expanded configuration schema reference with complete tables and sections covering authentication, authorization, database, and other configuration options.
  • Restored and standardized HTML formatting across configuration reference materials.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation HTML file docs/config.html undergoes a comprehensive formatting and content restoration, including XML declaration normalization, HTML entity escaping, and expansion of configuration schema tables and resource sections across multiple configuration blocks such as AuthenticationConfiguration, AuthorizationConfiguration, JwtConfiguration, and LlamaStackConfiguration.

Changes

Cohort / File(s)

Change Summary

Configuration Documentation Restructuring docs/config.html

Normalized XML declaration, reorganized head/meta/style blocks, escaped HTML entities in selectors and markup, reconstructed and expanded configuration schema content with complete HTML tables, headings, and descriptive sections for authentication, authorization, BYOK RAG, CORS, JWT, MCP, and database configurations. Standardized table structures with colgroup, thead, and tbody elements throughout.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Review focuses on validation of HTML structure integrity (proper tag closure, table formatting consistency)
• Verification of configuration documentation content accuracy and completeness across multiple schema sections
• Confirmation that restored content and entity escaping align with intended configuration specifications
• Large file size offset by repetitive, homogeneous HTML table formatting patterns that reduce per-section cognitive load

Possibly related PRs

• LCORE-973: config documentation, 1st version #828: Originally introduced the docs/config.html file; this PR restores and expands its content structure.
• LCORE-304: Updated config diagram #263: Updates configuration documentation and modifies LlamaStackConfiguration entity that overlaps with this PR's configuration schema expansion.
• LCORE-973: configuration options descriptions #854: Adds descriptive tables and fields for ServiceConfiguration, LlamaStackConfiguration, MCP, JWT, and CORS sections with semantic overlap to this PR's documentation updates.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title references a ticket (LCORE-533) and indicates the main change is updating configuration documentation, which aligns with the comprehensive formatting and content restoration of docs/config.html shown in the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/config.html (2)

1-1: Note: XML declaration on auto-generated HTML file.

The XML declaration on line 1 is valid but unusual for HTML5 documents. If this file is auto-generated (as indicated by the Pandoc meta tag on line 6), ensure the generation tool is configured correctly. If manually editing, consider whether the XML declaration is necessary for your deployment target.

If you control the generation tool, you can remove the XML declaration or keep it depending on your serialization requirements. For pure HTML5 served over HTTP, it's typically omitted.

---

82-82: HTML entity escaping in CSS selectors is non-standard.

Lines 82 and 149 contain escaped angle brackets in CSS selectors (li > ol and #TOC > ul). While browsers correctly handle this (unescaping before CSS parsing), the conventional approach in HTML style blocks is to use literal > characters without HTML entity escaping.

This is likely an artifact of the Pandoc generation process. If you're generating this file from Markdown or another source, verify the generation tool's output settings.

For reference, the selectors would be clearer without entity escaping:

li > ol, li > ul { ... }
#TOC > ul { ... }

Also applies to: 149-149

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fa9332c and fdc1455.

📒 Files selected for processing (1)

• docs/config.html (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)

• GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
• GitHub Check: pydocstyle
• GitHub Check: integration_tests (3.13)
• GitHub Check: unit_tests (3.13)
• GitHub Check: E2E: library mode / azure
• GitHub Check: E2E: server mode / azure
• GitHub Check: E2E: server mode / ci
• GitHub Check: E2E: library mode / ci

🔇 Additional comments (1)

docs/config.html (1)

176-1305: Configuration documentation is comprehensive and well-structured.

The restored configuration schema documentation includes:

• 26 configuration sections with proper descriptions
• Well-formed HTML tables with Field, Type, and Description columns
• Descriptive text and useful resource links for complex sections (e.g., CORS, JWT, TLS, PostgreSQL)
• Consistent table formatting with proper thead/tbody and column group specifications

The content appears complete and well-organized. All configuration options are documented with types and descriptions.