Skip to content

Refactor consildate and optimize documentation #111

@blindzero

Description

@blindzero

Problem Statement

Today, parts of this story are distributed across multiple documents (README, installation, releases, provider docs), which can lead to duplication or inconsistencies over time.

Additionally, the documentation structure should remain:

  • small and focused (prefer fewer docs over more),
  • target-audience aware (Admins vs Developers),
  • and avoid “sprawl” while keeping key information discoverable.

Proposed Solution

  1. Single source of truth

Introduce exactly one document that owns the any definition or rule set, including:

Review existing docs and reduce duplication by:

  • Moving all “what gets imported / what is optional” content into the single source document
  • Replacing duplicated sections elsewhere with short references (links) to the source
  • Keeping README.md high-level only (link to installation/policy), not a second policy definition
  • Keeping "drill-down-for-details" principle over the documentations

All other docs must reference the single source instead of re-stating rules.

  1. Audience split - Users (= Admins) vs Developers
  • User-facing content:
    • installation incl. import policy
    • “how to run”
    • “what to install if you use provider X”
    • "how to define workflows" (linking to references, like providers and steps)
  • Developer-facing content:
    • authoring contract (prerequisites checks, dependency policy, provider contract)
    • contribution, extension, security, incl. testing, styleguide
    • packaging/release mechanics (how the artifact is staged)

Do not create new documents unless strictly necessary; prefer merging over splitting

Impact

  • Improves clarity for users and contributors.
  • Reduces maintenance burden (single place to update).

Metadata

Metadata

Labels

prio:hightype:docsImprovements or additions to documentation.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions