LCORE-1170: Updated configuration documentation

[tisnik]

Description

LCORE-1170: Updated configuration documentation

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

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

Related Tickets & Documents

• Related Issue #LCORE-1170

Summary by CodeRabbit

Documentation

• Added A2AStateConfiguration section documenting persistent state storage options for A2A protocol, including SQLite and PostgreSQL alternatives
• Introduced new configuration fields: a2a_state for A2A state management, agent_card_path and agent_card_config for agent customization, and base_url for service accessibility
• Updated configuration documentation to support extended customization and service configuration options

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

[coderabbitai]

Walkthrough

Documentation updates extending configuration schema with A2A protocol support, including new A2AStateConfiguration section for persistent state storage with SQLite/PostgreSQL options, plus new customization and service configuration fields (agent_card_path, agent_card_config, base_url).

Changes

Cohort / File(s)	Summary
Configuration Documentation docs/config.html, docs/config.md	Added A2AStateConfiguration section with sqlite and postgres fields for A2A persistent state storage; extended Customization with agent_card_path and agent_card_config; added base_url field to ServiceConfiguration; added a2a_state entry to service configuration table.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• #378: Adds DatabaseConfiguration section with sqlite/postgres-backed storage settings, following similar pattern to the new A2AStateConfiguration in this PR.
• #828: Introduces the base configuration documentation structure in docs/config.html and docs/config.md that this PR extends with A2A-specific sections and fields.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change—it's a documentation update to configuration files with added A2A state, customization, and service configuration sections.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

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.md (1)

195-196: Consider adding descriptions for the new customization fields.

Both agent_card_path and agent_card_config have empty descriptions, unlike other new fields added in this PR (e.g., base_url and a2a_state). Brief descriptions would help users understand their purpose for A2A support.

📝 Suggested descriptions

-| agent_card_path | string |  |
-| agent_card_config | object |  |
+| agent_card_path | string | Path to custom agent card configuration file for A2A protocol. |
+| agent_card_config | object | Agent card configuration object for A2A protocol customization. |

docs/config.html (1)

635-644: Same missing descriptions as in the markdown file.

Consider adding descriptions for agent_card_path and agent_card_config to maintain consistency with other documented fields.

📝 Suggested fix

         <tr class="odd">
           <td>agent_card_path</td>
           <td>string</td>
-          <td/>
+          <td>Path to custom agent card configuration file for A2A protocol.</td>
         </tr>
         <tr class="even">
           <td>agent_card_config</td>
           <td>object</td>
-          <td/>
+          <td>Agent card configuration object for A2A protocol customization.</td>
         </tr>

📜 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 420784e and 218e021.

📒 Files selected for processing (2)

• docs/config.html
• docs/config.md

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-12-18T10:21:09.038Z

Learnt from: are-ces
Repo: lightspeed-core/lightspeed-stack PR: 935
File: run.yaml:114-115
Timestamp: 2025-12-18T10:21:09.038Z
Learning: In Llama Stack version 0.3.x, telemetry provider configuration is not supported under the `providers` section in run.yaml configuration files. Telemetry can be enabled with just `telemetry.enabled: true` without requiring an explicit provider block.

Applied to files:

• docs/config.html

⏰ 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). (4)

• GitHub Check: build-pr
• GitHub Check: E2E: library mode / ci
• GitHub Check: E2E: server mode / ci
• GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request

🔇 Additional comments (4)

docs/config.md (2)

8-29: LGTM! Well-documented A2A state configuration section.

The section clearly explains the purpose, storage options (SQLite/PostgreSQL), default behavior (in-memory), and deployment considerations (multi-worker vs single-worker). This provides users with actionable guidance for configuring A2A state persistence.

---

153-153: LGTM! New A2A-related fields properly documented.

The a2a_state field in Configuration and base_url field in ServiceConfiguration have clear descriptions explaining their purpose for A2A protocol support.

Also applies to: 489-489

docs/config.html (2)

179-215: LGTM! HTML documentation matches the markdown version.

The A2AStateConfiguration section is correctly rendered with proper HTML structure, including the descriptive paragraphs and field table.

---

531-534: LGTM! A2A-related fields correctly added to HTML tables.

The a2a_state and base_url fields are properly documented with descriptions, and the row class alternations have been correctly adjusted in the ServiceConfiguration table after the insertion.

Also applies to: 1271-1307