Community surface: ROADMAP, issue/PR templates, troubleshooting (addresses #18) - #20
Merged
Merged
Conversation
#18) Addresses the "community surface" and troubleshooting items from the outside review in #18. All additive, no code touched: - ROADMAP.md: the semver contract, the design invariants (no-LLM/local/ traceable/governed) stated as non-negotiable, what shipped in 1.0.0, a help-wanted near-term list, and — on-brand — an explicit "not planned" section tied to the documented measured ceilings (naive distillation 0.37->0.08, whole-conversation aggregation). - .github/ISSUE_TEMPLATE/: a bug report that pre-fills the `midas doctor` block (config paths/versions only, safe to paste), a feature request that asks up front whether it adds an LLM to the ingest/query path, and a config.yml routing questions to Discussions and the benchmark repro. - .github/PULL_REQUEST_TEMPLATE.md: a checklist that separates the measure-everything core bar from the lighter docs/examples path. - README "Troubleshooting": surfaces `midas doctor` as the one-command diagnosis with a symptom -> fix table (the #18 P2 ask). - CONTRIBUTING "A lighter bar for docs & examples": explicitly relaxes the eval-first bar for docs/guides/examples so first contributions aren't gated by the retrieval-core rigor. Does not include the README comparison table — that's #19, already open. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Deray2qcPRy1hZVQnboHp4
vornicx
marked this pull request as ready for review
July 6, 2026 21:41
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
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.
Implements the cheap, high-signal in-repo items from the outside review in #18 (P1.2 community surface + the P2 troubleshooting ask). All additive — no product code touched, based on current
main(1.0.0).What's here
ROADMAP.md— the semver contract made visible (as Feedback from a happy user: pre-1.0 credibility gaps + a distribution plan (Midas deserves way more visibility) #18 suggested), the design invariants stated as non-negotiable (no-LLM / local / source-traceable / governed), what shipped in 1.0.0, a help-wanted near-term list, and — on brand — an explicit "not planned" section tied to the measured ceilings (naive distillation 0.37→0.08, whole-conversation aggregation). It admits the trade in the same place it states the plan..github/ISSUE_TEMPLATE/— a bug report that pre-fills themidas doctorblock (config paths + versions only, safe to paste), a feature request that asks up front whether the idea adds an LLM to the ingest/query path (so the eval-first bar is set before the discussion starts), and aconfig.ymlrouting questions to Discussions and to the benchmark-repro invitation..github/PULL_REQUEST_TEMPLATE.md— a checklist that separates the measure-everything core bar from the lighter docs/examples path.midas doctoras the one-command diagnosis with a symptom→fix table (the Feedback from a happy user: pre-1.0 credibility gaps + a distribution plan (Midas deserves way more visibility) #18 P2 ask).Deliberately not here
BENCHMARKS.md(all check out); no reason to duplicate it.🤖 Generated with Claude Code
https://claude.ai/code/session_01Deray2qcPRy1hZVQnboHp4
Generated by Claude Code