Skip to content

docs: point the license references at the renamed file - #259

Merged
tas50 merged 2 commits into
mainfrom
docs/license-link
Aug 30, 2026
Merged

docs: point the license references at the renamed file#259
tas50 merged 2 commits into
mainfrom
docs/license-link

Conversation

@tas50

@tas50 tas50 commented Aug 30, 2026

Copy link
Copy Markdown
Member

Renaming LICENSE.txt to LICENSE in #258 left two references behind. Both are fixed here.

  • README.md linked [LICENSE.txt](LICENSE.txt), which 404s on GitHub.
  • .yardopts listed LICENSE.txt as an extra file, so every yard run printed [warn]: Could not find file: LICENSE.txt and the license was silently dropped from the generated documentation.

Verification

$ yard stats
100.00% documented          # and no "Could not find file" warning

Before this change:

[warn]: Could not find file: LICENSE.txt

tas50 added 2 commits August 29, 2026 19:12
LICENSE.txt became LICENSE in #258, so the link at the bottom of the
README is now a 404.

Signed-off-by: Tim Smith <tim@mondoo.com>
The LICENSE.txt to LICENSE rename left .yardopts naming a file that no
longer exists, so every yard run warned "Could not find file:
LICENSE.txt" and the license was silently dropped from the generated
docs.

Signed-off-by: Tim Smith <tim@mondoo.com>
@tas50 tas50 changed the title docs: point the README license link at the renamed file docs: point the license references at the renamed file Aug 30, 2026
@tas50
tas50 merged commit 109dcc3 into main Aug 30, 2026
10 checks passed
@tas50
tas50 deleted the docs/license-link branch August 30, 2026 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant