Skip to content

Sync documentation#802

Merged
FuJacob merged 3 commits into
mainfrom
agent/sync-documentation
Jul 18, 2026
Merged

Sync documentation#802
FuJacob merged 3 commits into
mainfrom
agent/sync-documentation

Conversation

@FuJacob

@FuJacob FuJacob commented Jul 18, 2026

Copy link
Copy Markdown
Owner

syncing documents

Greptile Summary

This PR syncs three documentation files to reflect new components and architectural refinements already present in the codebase. No production code is changed.

  • AGENTS.md / ARCHITECTURE.md: Adds entries for SuggestionStreamingState, PostExhaustionAcceptanceState, OpenAICompatibleSuggestionEngine, and SuggestionSettingsData; all four Swift files are confirmed to exist at their stated paths. Removes stale references to runConstrainedDecode and cotabbyConstrainedDecoderEnabled, which are no longer present in the codebase.
  • .claude/CLAUDE.md: Tightens the description of AGENTS.md's role and adds a cross-reference to ARCHITECTURE.md and the gitignored .internal/ directory.

Confidence Score: 5/5

Documentation-only changes; all referenced Swift files were verified present in the repo and removed symbols confirmed absent from code.

Every new component name and file path cited in the updated docs was cross-checked against the actual source tree — all exist. The deleted constrained-decoder references are gone from the Swift files too, so the docs accurately describe the current state of the code. No production logic is touched.

No files require special attention.

Important Files Changed

Filename Overview
.claude/CLAUDE.md Clarifies AGENTS.md scope, adds ARCHITECTURE.md cross-reference, and acknowledges the gitignored .internal/ directory — no issues found.
AGENTS.md Adds SuggestionStreamingState, PostExhaustionAcceptanceState, OpenAICompatibleSuggestionEngine, and SuggestionSettingsData/Snapshot entries; all referenced Swift files verified present in the repo.
ARCHITECTURE.md Adds hyperlinked entries for SuggestionStreamingState, PostExhaustionAcceptanceState, and SuggestionSettingsData; expands troubleshooting table with two new rows; removed constrained-decoder references match their removal from code.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    CLAUDE[".claude/CLAUDE.md\n(agent entry point)"] --> AGENTS["AGENTS.md\ncanonical coding-agent instructions"]
    CLAUDE --> ARCH["ARCHITECTURE.md\nten-minute system map"]
    CLAUDE --> INTERNAL[".internal/\ngitignored deep-dive docs"]

    AGENTS --> SM["Suggestion State Machine"]
    SM --> SSM["SuggestionSettingsModel\n@Published UI-facing surface"]
    SSM --> SSD["SuggestionSettingsData\ndomain projection"]
    SSD --> SSS["SuggestionSettingsSnapshot\nimmutable pipeline boundary"]

    SM --> COORD["SuggestionCoordinator\norchestration + presentation state"]
    COORD --> SRS["SuggestionStreamingState\nlatest-wins coalescing"]
    COORD --> PEAS["PostExhaustionAcceptanceState\nbounded Tab-ownership window"]

    SM --> ENG["SuggestionEngineRouter"]
    ENG --> FME["FoundationModelSuggestionEngine\nApple on-device"]
    ENG --> LSE["LlamaSuggestionEngine\nllama.cpp path"]
    ENG --> OAI["OpenAICompatibleSuggestionEngine\nSSE streaming + Ollama preload"]
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    CLAUDE[".claude/CLAUDE.md\n(agent entry point)"] --> AGENTS["AGENTS.md\ncanonical coding-agent instructions"]
    CLAUDE --> ARCH["ARCHITECTURE.md\nten-minute system map"]
    CLAUDE --> INTERNAL[".internal/\ngitignored deep-dive docs"]

    AGENTS --> SM["Suggestion State Machine"]
    SM --> SSM["SuggestionSettingsModel\n@Published UI-facing surface"]
    SSM --> SSD["SuggestionSettingsData\ndomain projection"]
    SSD --> SSS["SuggestionSettingsSnapshot\nimmutable pipeline boundary"]

    SM --> COORD["SuggestionCoordinator\norchestration + presentation state"]
    COORD --> SRS["SuggestionStreamingState\nlatest-wins coalescing"]
    COORD --> PEAS["PostExhaustionAcceptanceState\nbounded Tab-ownership window"]

    SM --> ENG["SuggestionEngineRouter"]
    ENG --> FME["FoundationModelSuggestionEngine\nApple on-device"]
    ENG --> LSE["LlamaSuggestionEngine\nllama.cpp path"]
    ENG --> OAI["OpenAICompatibleSuggestionEngine\nSSE streaming + Ollama preload"]
Loading

Reviews (1): Last reviewed commit: "Clarify internal documentation scope" | Re-trigger Greptile

@FuJacob
FuJacob marked this pull request as ready for review July 18, 2026 05:37
@FuJacob
FuJacob merged commit e0ca317 into main Jul 18, 2026
5 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