Skip to content

docs(readme): link Project files table to docs/, CHANGELOG, SECURITY (RAN-64)#5

Merged
aksOps merged 1 commit intomainfrom
chore/ran-64-readme-docs-link
Apr 26, 2026
Merged

docs(readme): link Project files table to docs/, CHANGELOG, SECURITY (RAN-64)#5
aksOps merged 1 commit intomainfrom
chore/ran-64-readme-docs-link

Conversation

@aksOps
Copy link
Copy Markdown
Contributor

@aksOps aksOps commented Apr 26, 2026

Summary

Closes the "README links to it" item on RAN-64. PR #4 already added CHANGELOG.md and docs/README.md to satisfy the bestpractices.dev autofill criteria (release_notes + documentation_basics). This follow-up makes the new files discoverable from the top-level README so a human reader landing on the repo finds them without spelunking the file tree.

What changed

Single-file diff: +7 / −1.

Out of scope (per RAN-64 description)

Test plan

Closes RAN-64.

🤖 Generated with Claude Code

…(RAN-64)

Closes the "README links to it" item on RAN-64. PR #4 already added
CHANGELOG.md and docs/README.md to satisfy the bestpractices.dev
release_notes + documentation_basics autofill criteria; this follow-up
makes the new files discoverable from the top-level README so a human
reader landing on the repo finds them without spelunking the file tree.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
@aksOps aksOps enabled auto-merge (squash) April 26, 2026 04:09
@aksOps aksOps merged commit 7f0902e into main Apr 26, 2026
12 checks passed
@aksOps aksOps deleted the chore/ran-64-readme-docs-link branch April 26, 2026 04:10
aksOps added a commit that referenced this pull request Apr 26, 2026
…ersioning evidence (#8)

CHANGELOG.md
- [Unreleased] → [v0.1.0] - 2026-04-26 with full Added / Changed / Fixed / Security
  subsections covering PR #1 (RAN-54 baseline + Scorecard hardening), PR #3 (RAN-59
  canonical-schema rewrite), PRs #4/#5 (RAN-64 CHANGELOG + docs/ index), PR #6
  (5 SUGGESTED criteria flips), PR #7 (CONTRIBUTING.md + conventional-URL retargets).
- Fresh empty [Unreleased] section opened at top per Keep-a-Changelog 1.1.0.
- Link refs now point at compare/v0.1.0...HEAD and releases/tag/v0.1.0.

.bestpractices.json
- version_unique_url + release_notes_vulns_url added (both pointing at the v0.1.0
  GitHub Release) so the bestpractices.dev autofill bot has a concrete URL to
  verify alongside _status: Met.
- 5 versioning justifications refreshed to cite the concrete v0.1.0 tag instead of
  forward-looking commitments: version_unique, version_semver, version_tags,
  release_notes, release_notes_vulns. These are the criteria the autofill bot
  verifies by checking actual GitHub Releases / git tags exist.

Once the v0.1.0 signed tag + GitHub Release land post-merge, autofill should flip
release_notes to Met (currently Unmet pending evidence) and the 4 SUGGESTED
versioning criteria stay Met with concrete tag-backed URLs.

Co-authored-by: Paperclip <noreply@paperclip.ing>
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