Skip to content

Extend docsync into runnable quickstart smoke coverage #347

@julianknutsen

Description

@julianknutsen

Problem

Gas City's current docsync coverage verifies command mentions, local markdown links, and Mintlify nav references, but it does not prove that the documented quickstart actually runs from a clean environment.

That means docs can stay well-linked while drifting away from real CLI behavior.

Scope

  • start from the current quickstart and tutorial entry path
  • build gc and run a minimal docs-backed flow in a temp workspace
  • fail loudly when docs drift from actual CLI behavior

Acceptance Criteria

  • docs validation covers at least one runnable quickstart path
  • the check is suitable for CI or a maintainer pre-release pass
  • drift between docs and real behavior is surfaced automatically
wasteland:
  type: bug
  priority: 1
  effort: medium

Metadata

Metadata

Assignees

Labels

kind/choreInternal improvement (refactor, tests, CI, tooling)priority/p2Medium — real problem, workaround existswastelandTracked by Wasteland sync

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions