Skip to content

fix(distribution): winget manifest Documentation link points to nonexistent wiki #167

Description

@dvalfrid

Problem

winget show Codeby.RIGStats reports:

Documentation:
  Wiki: https://github.com/dvalfrid/rigstats/wiki

We have no GitHub Wiki, so this link 404s for anyone who follows it.

Root cause

  • The Documentations field is not present in this repo's mirrored manifest snapshot (winget/manifests/c/Codeby/RIGStats/1.35.1/Codeby.RIGStats.locale.en-US.yaml).
  • .github/workflows/winget-submit.yml only runs wingetcreate.exe update --version --urls --submit after each release — this patches version/installer fields on top of whatever is currently live upstream in microsoft/winget-pkgs, but never touches locale fields like Documentations.
  • So the wrong Wiki entry was set once directly in the upstream manifest (likely via wingetcreate's interactive prompt guessing a conventional .../wiki URL) and has silently persisted through every automated version bump since, because nothing in our pipeline ever revisits it.

Recommendation

Don't stand up a real GitHub Wiki — it would just be a second, easily-stale copy of the docs we already maintain in docs/ (setup.md, troubleshooting.md, architecture.md, release.md), linked from the README's documentation table.

Instead, fix it upstream: submit a one-off manifest-only PR to microsoft/winget-pkgs changing:

Documentations:
  - DocumentLabel: Wiki
    DocumentUrl: https://github.com/dvalfrid/rigstats/wiki

to point at real docs instead, e.g.:

Documentations:
  - DocumentLabel: Documentation
    DocumentUrl: https://github.com/dvalfrid/rigstats#readme

(Alternative target worth considering: docs/troubleshooting.md directly, since that's most relevant to someone looking at winget show output.)

No changes needed in this repo — winget-submit.yml never touches this field, so the fix will carry forward automatically on future releases once corrected upstream.

Verification

After the winget-pkgs PR merges, re-run winget show Codeby.RIGStats and confirm the Documentation: section shows the corrected URL.


Deferred: picking this up once the current in-flight MR lands.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions