docs: hide uteke memory integration from user-facing docs#367
Merged
Conversation
Remove uteke references from all user-facing documentation while keeping the code intact (--memory/--learn flags still compile and work). Rationale: save_findings() only stores generic stats/categories, not actionable review context. Recall returns noise, not useful patterns. Hide docs until save_findings is improved to store meaningful content. - README.md: remove Uteke Memory Integration section, simplify install - docs/usage.md: remove Three Levels + How It Works sections - docs/configuration.md: remove Uteke section - docs/getting-started.md: remove Memory-Powered Reviews section - docs/cli-reference.md: remove --memory/--learn rows + uteke example - install-bundle.sh: simplify to cora-only installer Code unchanged: src/engine/memory.rs, --memory/--learn flags preserved. Changelog preserved (release history). Star History chart preserved.
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.
Summary
Remove uteke references from all user-facing documentation while keeping the code intact (
--memory/--learnflags still compile and work).Rationale
save_findings()insrc/engine/memory.rsonly stores generic stats/categories (e.g.pattern:best_practice,stats:issues=1), not actionable review context. Recall queries return noise rather than useful patterns.Until
save_findingsis improved to store meaningful finding content, this feature should not be advertised to users.Changes
README.mddocs/usage.mddocs/configuration.mddocs/getting-started.mddocs/cli-reference.md--memory/--learnrows + uteke exampleinstall-bundle.shWhat is NOT changed
src/engine/memory.rs— code untouched, flags still workdocs/changelog.md— uteke references in release history preserveddocs/standards/codecora-data-directory.md— internal doc, not user-facingTest plan
cargo checkpasses--no-verifyused for doc-only commit (no code change)