Skip to content

[DOCS-05] Build bilingual documentation quality, link, example, and version checks #6

Description

@jaavid

Background

CoreLink is managed as one product across multiple implementation repositories. This work is the executable technical task owned by developer-docs under EPIC-05.

Problem

The documentation stack has versioned information architecture, but it still lacks complete retained quality evidence for bilingual content, links, examples and version claims across the supported docs surface.

Goal

Build bilingual documentation quality, link, example and version checks with repeatable evidence and no divergence from supported product maturity claims.

Parent

  • Primary Product Epic: EPIC-05
  • Backlog ID: DOCS-05

Scope

  • Validate internal/external links and version references.
  • Validate runnable examples against their declared contract/tool versions.
  • Add quality checks appropriate for English/Persian documentation where supported.
  • Retain CI evidence suitable for the Beta product gate.

Out of Scope

  • Treating lint/link success as proof that the underlying product capability is accepted.
  • Creating a separate repository roadmap.
  • Expanding product claims beyond supported maturity.

Acceptance Criteria

  • Link and version-reference checks cover the supported documentation surface.
  • Runnable examples are checked against declared versions or explicitly marked non-runnable/scaffold.
  • Bilingual quality rules are documented and enforced where bilingual content is published.
  • CI failures are actionable and do not silently skip required checks.
  • Evidence from the accepted documentation revision is retained and linked.
  • EPIC-05 documentation-quality exit criteria are measurably advanced.

Dependencies and acceptance state

  • Prerequisite completed: DOCS-01 is closed/completed and established the versioned information architecture.
  • Execution inputs: the currently supported documentation/release matrix and runnable examples from DOCS-02 through DOCS-04.
  • Blocks: EPIC-05 Beta documentation-quality acceptance and release-readiness claims that depend on validated docs/examples.
  • Current dependency state: See the CoreLink Product organization Project.

Planning Metadata

  • Type: Technical Task
  • Priority snapshot: P1
  • Product milestone snapshot: Beta
  • Domain snapshots: docs, devex
  • Area snapshot: documentation
  • Complexity: M
  • Created in status: Triage
  • Current status and DRI: See the CoreLink Product organization Project.
  • Intended repository labels: type:technical-task

Definition of Done

  • Acceptance criteria demonstrated.
  • Required documentation checks pass on the accepted revision.
  • Version and maturity claims are reconciled with supported releases.
  • Examples are validated or explicitly classified.
  • Evidence is retained and linked.
  • Documentation/release notes are updated where applicable.
  • Pull request(s) are merged and linked.

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:technical-taskImplementation or engineering enablement work

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions