Skip to content

docs: add dedicated Configuration sections for CLP components #2502

Description

@coderabbitai

Summary

Add a dedicated Configuration section to the user documentation for CLP components. Start with compression-coordinator, and use a configuration-list format consistent with the Spider scheduler guide.

Rationale

The compression-coordinator guide describes configuration values in feature-specific text. A dedicated Configuration section gives users one location to find all supported settings. The same documentation pattern should be available for other CLP components.

Affected areas

  • docs/src/user-docs/guides-using-compression-coordinator.md
  • Related component guide pages under docs/src/user-docs/
  • Documentation navigation or shared configuration-list conventions, if needed

Required changes

  1. Define a reusable documentation structure for component-level Configuration sections.
  2. Add a Configuration section to the compression-coordinator guide.
  3. List supported compression-coordinator configuration values and their meanings.
  4. Link each setting to its authoritative configuration reference where available.
  5. Identify and apply the same structure to other component guides as appropriate.

Acceptance criteria

  • The compression-coordinator guide has a dedicated Configuration section.
  • The section provides a complete, user-facing list of supported compression-coordinator settings.
  • The formatting is consistent with the Spider scheduler guide configuration list.
  • The documentation clearly distinguishes component-specific settings from Spider scheduler settings.
  • The approach supports adding equivalent sections to other component guides.

Backlinks

Requested by: @LinZhihao-723

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions