docs: update README for v1.2.8-max - #25
Merged
Merged
Conversation
Reviewer's GuideDocs-only README synchronization for v1.2.8-max, adding release-specific UI, workflow, security, Skill Hub, prompt/context, module, tool, and testing information in both English and Chinese. Sequence diagram for the assistant processing timelinesequenceDiagram
participant User
participant ChatUI
participant AssistantTurn
participant ToolRegistry
participant Agent
User->>ChatUI: send message
ChatUI->>AssistantTurn: render processing timeline
AssistantTurn->>AssistantTurn: render reasoning
AssistantTurn->>ToolRegistry: dispatch tool call
ToolRegistry-->>AssistantTurn: tool result or error
AssistantTurn->>Agent: render Agent progress
Agent-->>AssistantTurn: agent_output
AssistantTurn-->>ChatUI: persist processing duration
AssistantTurn-->>User: show expandable timeline and final answer
Flow diagram for v1.2.8-max execution permissionsflowchart LR
Request["Tool or Agent request"] --> Mode{"Execution mode"}
Mode -->|automatic| Execute["Execute through ToolExecutor"]
Mode -->|confirmation| Review["ToolReviewListener approval"]
Mode -->|read-only| Restrict["Allow read-only operations"]
Review --> Scope["Match execution mode, tool, command, and working directory"]
Scope --> Execute
Execute --> Policy["FileToolPathPolicy workspace check"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README.md" line_range="168" />
<code_context>
│ └── ai/message/ # SystemModelMessage, UserModelMessage, etc.
├── feature-ssh/ # :feature-ssh — SshService, SshConnectionPool, TermuxHelper
├── feature-share/ # :feature-share — export/share/PDF
+├── tool-ui/ # :tool-ui — reusable tool-call cards and view registry
├── app/ # :app — MainActivity, MainCoordinator, controllers, UI components
│ ├── build.gradle.kts
</code_context>
<issue_to_address>
**nitpick:** The new module layout introduces `:tool-ui`, but the Tool system section still directs contributors to `app/src/main/java/cn/lineai/ui/component/toolcall/` for the tool-call card implementations. Those cards now live under `tool-ui/src/main/java/cn/lineai/tool/ui/`, so the documentation sends readers to a path that does not contain the documented classes.
**Suggested fix:** Update the Tool system path in both READMEs to the `tool-ui/src/main/java/cn/lineai/tool/ui/` location, and mention the remaining app integration classes separately if needed.
</issue_to_address>
### Comment 2
<location path="README.md" line_range="126" />
<code_context>
+- **Safer execution approvals.** Automatic, confirmation, and read-only modes are aligned across the main flow and Agents. Permanent approvals match the full execution scope, tool, command, and working directory.
+- **Skill Hub.** Browse and search community Skills, inspect files, versions, comments, evaluations, previews, and security hints, then sign in, install, publish, and manage community Skills from the app.
+- **Prompt and context stability.** Stable system prefixes, deterministic tool/extension ordering, canonical JSON serialization, attachment-local context, and corrected post-compaction token baselines improve cache reuse and prevent repeated compaction.
+- **Release verification.** Robolectric 4.16 native View tests cover layouts, timelines, permissions, prompts, Skill Hub flows, and diff rendering; the v1.2.8-max release notes record 528 passing unit tests plus successful Debug/DebugUserCert builds and lint.
+
---
</code_context>
<issue_to_address>
**nitpick:** The release-verification text attributes Skill Hub flows and diff rendering to Robolectric native View tests, but the corresponding Skill Hub client/session/controller tests and `ConversationTimelineTest`/`DiffLinesTest` are ordinary JUnit tests without a Robolectric runner. Only the layout tests use Robolectric, so this wording overstates what was verified by Robolectric and misstates the test coverage.
**Suggested fix:** Separate the Robolectric layout/View coverage from the plain JUnit Skill Hub, timeline, and diff-model/controller tests, or qualify the claim as coverage by the combined test suite.
```suggestion
- **Release verification.** Robolectric 4.16 native View tests cover layouts, while the combined test suite covers timelines, permissions, prompts, Skill Hub flows, and diff rendering; the v1.2.8-max release notes record 528 passing unit tests plus successful Debug/DebugUserCert builds and lint.
```
</issue_to_address>Sourcery assessment
Approved.
| │ └── ai/message/ # SystemModelMessage, UserModelMessage, etc. | ||
| ├── feature-ssh/ # :feature-ssh — SshService, SshConnectionPool, TermuxHelper | ||
| ├── feature-share/ # :feature-share — export/share/PDF | ||
| ├── tool-ui/ # :tool-ui — reusable tool-call cards and view registry |
There was a problem hiding this comment.
nitpick: The new module layout introduces :tool-ui, but the Tool system section still directs contributors to app/src/main/java/cn/lineai/ui/component/toolcall/ for the tool-call card implementations. Those cards now live under tool-ui/src/main/java/cn/lineai/tool/ui/, so the documentation sends readers to a path that does not contain the documented classes.
Suggested fix: Update the Tool system path in both READMEs to the tool-ui/src/main/java/cn/lineai/tool/ui/ location, and mention the remaining app integration classes separately if needed.
| - **Safer execution approvals.** Automatic, confirmation, and read-only modes are aligned across the main flow and Agents. Permanent approvals match the full execution scope, tool, command, and working directory. | ||
| - **Skill Hub.** Browse and search community Skills, inspect files, versions, comments, evaluations, previews, and security hints, then sign in, install, publish, and manage community Skills from the app. | ||
| - **Prompt and context stability.** Stable system prefixes, deterministic tool/extension ordering, canonical JSON serialization, attachment-local context, and corrected post-compaction token baselines improve cache reuse and prevent repeated compaction. | ||
| - **Release verification.** Robolectric 4.16 native View tests cover layouts, timelines, permissions, prompts, Skill Hub flows, and diff rendering; the v1.2.8-max release notes record 528 passing unit tests plus successful Debug/DebugUserCert builds and lint. |
There was a problem hiding this comment.
nitpick: The release-verification text attributes Skill Hub flows and diff rendering to Robolectric native View tests, but the corresponding Skill Hub client/session/controller tests and ConversationTimelineTest/DiffLinesTest are ordinary JUnit tests without a Robolectric runner. Only the layout tests use Robolectric, so this wording overstates what was verified by Robolectric and misstates the test coverage.
Suggested fix: Separate the Robolectric layout/View coverage from the plain JUnit Skill Hub, timeline, and diff-model/controller tests, or qualify the claim as coverage by the combined test suite.
Suggested change
| - **Release verification.** Robolectric 4.16 native View tests cover layouts, timelines, permissions, prompts, Skill Hub flows, and diff rendering; the v1.2.8-max release notes record 528 passing unit tests plus successful Debug/DebugUserCert builds and lint. | |
| - **Release verification.** Robolectric 4.16 native View tests cover layouts, while the combined test suite covers timelines, permissions, prompts, Skill Hub flows, and diff rendering; the v1.2.8-max release notes record 528 passing unit tests plus successful Debug/DebugUserCert builds and lint. |
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\n\n- Sync README.md and README_CN.md with update.md for v1.2.8-max\n- Document the native UI refresh, conversation timeline, permission modes, Skill Hub, prompt/context stability, and Robolectric 4.16 verification\n- Update the version badge, module layout, AgentOutputTool, and test guidance\n\n## Verification\n\n- git diff --check\n\nDocs-only change; build tests were not run.
Summary by Sourcery
Update the English and Chinese README files to accurately document the v1.2.8-max release and current project structure.
Enhancements:
Documentation: