github: community files, FAQ, llms.txt, citation, and a place for the demo GIF - #124
Merged
Merged
Conversation
… demo GIF Discovery and first-impression work, no engine change. - .github/: issue forms (bug report asks for the packet and the reason dump; feature request asks for the code shape and a public repo to measure on), PR template whose checklist is the project's own rule (holdouts never drop, name the signal not the threshold), SECURITY.md scoped to leakage and path escape, CONTRIBUTING.md with the measurement rule up front. - docs/faq.md: the questions people ask before trying it — what it is, how it differs from embedding search, whether code leaves the machine, how accurate it really is, whether a smaller packet hurts the model — each answered with the holdout number behind it. - llms.txt: a short machine-readable summary with the quotable facts and the doc map, so assistants describe the project (and its attribution) correctly. - CITATION.cff so GitHub offers a citation, crediting the NeuroMesh baseline. - README: FAQ in the nav and the doc table, contributing points at .github, and a commented-out block at docs/assets/demo.gif for the demo recording. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Formatting only, no logic change. `cargo fmt --all --check` has been failing on main since the dashboard settings work landed, which turns every PR's CI red. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Discovery and first-impression work — no engine change.
NM_EXPLAINreason dump; the feature form asks for the code shape and a public repo it can be measured on), a PR template whose checklist is the project's own rule (holdouts never drop; name the signal, not the threshold),SECURITY.mdscoped to cross-project leakage and path escape,CONTRIBUTING.mdwith the measurement rule first.docs/assets/demo.gif.Community-profile checklist after this: description ✔ · README ✔ · license ✔ · contributing ✔ · code of conduct ✘ (deliberate, single-maintainer) · issue templates ✔ · PR template ✔ · security policy ✔.
🤖 Generated with Claude Code