Skip to content

docs: cut stale design notes and fix the security report channel - #694

Merged
Mathih13 merged 2 commits into
mainfrom
docs/cut-stale-docs
Oct 13, 2026
Merged

Mathih13 merged 2 commits into
mainfrom
docs/cut-stale-docs

Conversation

@Mathih13

Copy link
Copy Markdown
Contributor

What and why

Some documents in docs/ record work that is already done. The two notes in docs/design/ describe an item GUID allocator and a loot roll promotion that are both in the code, plus a rollout checklist for each. No document linked to them. docs/benilla-compatibility.md ended with the test results of one past run, and its request counts were going stale. Nothing linked to it either.

SUPPORT.md, CONTRIBUTING.md and the issue templates told people to report a security problem through GitHub private vulnerability reporting. That feature is off for this repository, so those reports had nowhere to go.

This change:

  • Deletes docs/design/. The rules that still matter are now comments next to the code: the item GUID bit layout in module/src/items/guids.rs, and the receipt ordering and expiry rules in module/src/loot/rolls.rs.
  • Removes the run record, the fixed counts and the "this scenario found" history from docs/benilla-compatibility.md, and links it from docs/testing.md.
  • Sends security reports to a private message to a maintainer on the Discord server, and names that server as an official channel.
  • Shortens SUPPORT.md, and moves the conduct line out of the out-of-scope list.

What you verified

  • rustfmt --check on the two changed Rust files
  • cargo check -p lyracore-module
  • Both issue template YAML files parse

What you did NOT verify

Only comments changed in the Rust files, so I did not run the test suites.

Made by Claude Opus 5.5 in Claude Code.

🤖 Generated with Claude Code

Mathih13 and others added 2 commits October 13, 2026 06:49
Remove the two implemented design notes and keep their lasting rules as
comments next to the code. Remove the dated verification record and fixed
counts from the Benilla doc and link it from testing.md. Tighten SUPPORT.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
GitHub private vulnerability reporting is off for this repository, so the
advisory links led nowhere. Point SUPPORT.md, CONTRIBUTING.md and the issue
templates at a private message to a maintainer on the Discord server.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Mathih13
Mathih13 merged commit 62703c3 into main Oct 13, 2026
9 checks passed
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