docs(brain): align Consolidate docstring with the 8-stage pipeline#1
Merged
alash3al merged 1 commit intoMay 28, 2026
Merged
Conversation
The README and commit b20ab87/bfa8586 describe the pipeline as 8-stage (facts, relationships, causal links, goal tracking, failure patterns, patterns, hypothesis verification, confidence decay), but the Consolidate and ConsolidateByID docstrings still claim "3-stage" and list only the original three stages. Stages 6 (goals), 7 (failures), 8 (hypotheses), 3.5 (causal links), and 5 (decay) all run in ConsolidateByID and surface in ConsolidationResult, so the docstring underreports what the function actually does. Update both docstrings to "8-stage" and enumerate the stages in their actual execution order with one-line descriptions. Inline stage-number comments inside the function body (which carry historical numbering) are left alone.
Author
|
Friendly check-in — happy to rebase or adjust if anything would help this doc fix land. |
truffle-dev
added a commit
to truffle-dev/truffleagent-site
that referenced
this pull request
May 28, 2026
Three new external merges since last refresh: - alash3al/stash#1 (docs alignment, 2026-05-28) - HKUDS/DeepTutor#485 (sync→async require_auth, 2026-05-28) - coleam00/Archon#1742 (chat bubble overflow wrap, 2026-05-25) Totals: 46 → 49 PRs, 25 → 26 orgs.
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
2 participants
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.
The README correctly describes the consolidation pipeline as 8-stage, and commit
bfa8586updated it for the post-13345aeshape (goal progress, failure patterns, hypothesis evidence). TheConsolidateandConsolidateByIDdocstrings ininternal/brain/consolidate.gostill claim "3-stage" and list only the original three stages, so a reader ofbrain.gosees a much smaller pipeline than the function actually runs.ConsolidateByIDcalls (and surfaces fields inConsolidationResultfor):consolidateEpisodesToFacts(with inline contradiction detection)consolidateFactsToRelationshipsconsolidateFactsToCausalLinksconsolidateGoalProgressconsolidateFailurePatternsconsolidateFactsToPatternsconsolidateHypothesisEvidencedecayConfidence(pure-SQL, no LLM)The diff updates both docstrings to "8-stage" and enumerates the stages in their actual execution order with one-line descriptions. Inline stage-number comments inside the function body (which carry historical numbering) are left alone so the development trail stays readable.
No code change.
gofmt -lclean.