Repository navigation
docs: overhaul documentation and introduce modern bilingual READMEs - #48
Merged
Merged
Conversation
- Transform README.md and introduce README_zh.md with an engaging, balanced narrative:
- Add real-world developer scenarios ("A Day with Squid"): terminal errors, cross-window context, smart notifications, and automatic privacy shields.
- Add 2-minute quickstart for both general users (prebuilt binaries) and developers (building from source).
- Document the Rust + Slint native desktop panel, tray keepalive, LLM request inspector with scrubbed preview modal, and real-time trigger ledger.
- Preserve all architectural deep dives ("Under the Hood"): SQLite WAL event store, canonical ordering, episodic world state, sliding attention window (SQUID_ATTENTION_WINDOW_MINUTES), and sub-second decision curation (/v1/systemone).
- Add full configuration reference table covering all 24 settings.
- Fix outdated documentation:
- Document Windows Named Pipe (\\.\pipe\...) support for the capture gate, terminal commands, and editor saves in AGENTS.md, docs/panel-protocol.md, and README.md.
- Document desktop notification gating: notifications only fire when the agent acted with mutating tools, avoiding spam during passive narration.
- Document agent_thinking, agent_triggers, and llm_log preview fields in docs/panel-protocol.md.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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.
Summary
This PR modernizes the project documentation and creates an engaging, bilingual (English & Chinese) presentation of Squid that balances user-friendly product experience with deep technical rigor:
README.md(English) and createdREADME_zh.md(简体中文) with top and bottom language switchers.chronicle-ordering.ts), episodic world state, sliding attention window (SQUID_ATTENTION_WINDOW_MINUTES), sub-second decision classifier (/v1/systemone), and strict shutdown ordering.AGENTS.md,README.md, anddocs/panel-protocol.mdthat previously claimed pause/FIFO features were unavailable on Windows. Documented support for Windows named pipes (\\.\pipe\...) across the capture gate, terminal commands, and editor saves.actedInLastTurn()like bash/edit/write), avoiding alert fatigue during passive narration.docs/panel-protocol.mdwith specifications foragent_thinking,agent_triggers, and the scrubbedpreviewfield inllm_log.Verification
bun test: 811 passed, 7 skipped, 0 failed.bun run typecheck: clean.