Skip to content

[Pipeline: provenance] Enforce raw manifest and docstring traceability for VASP #92

@newtontech

Description

@newtontech

tracking_id: lsp-perfect-20260615-vasp-lsp-provenance

Problem

Repo maintainability depends on every runtime rule and code docstring being traceable to LLM Wiki and raw evidence.

Target Repository

  • Repository: newtontech/VASP-LSP
  • Software/backend: VASP
  • Pipeline stage: provenance

Scope

  • Require code docstrings/doc comments to link to concrete wiki/*.md pages.
  • Require wiki raw references to exist and be represented in raw/assets/manifest.json.
  • Generate reports/docstring-wiki-raw-traceability.json or an equivalent provenance report in CI.

Acceptance Criteria

  • docstringsTotal equals docstringsLinked in the traceability report.
  • brokenWikiLinks, wikiSourcesWithoutRaw, and rawManifestFailures are zero.
  • The provenance report is committed and guarded by automated tests or CI scripts.

Deterministic Verification

  • python3 scripts/check_docstring_traceability.py --write-report --strict
  • python3 -m pytest tests/test_docstring_traceability.py when the repo is Python-based.

Implementation Notes

  • Follow the repeatable pipeline: official documentation capture -> wiki schema/rules -> provenance -> tests/evals -> LSP runtime/OpenQC integration.
  • Keep version-specific behavior explicit. Do not collapse incompatible software versions into one rule.
  • Do not claim parity with Python/C++ LSPs until diagnostics, completion/hover/symbols/format/fix surfaces have evidence and tests.
  • Link code docstrings to concrete wiki/*.md pages, and link every wiki source claim to a tracked raw/... asset when this stage touches code or docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions