Feat for documentation update#44
Merged
Merged
Conversation
- Improved cancel functionality to allow users to cancel ongoing operations using the Esc key in specific busy states (Thinking, Streaming, ToolRunning). - Updated TuiSessionState to transition to Idle state upon cancellation. - Enhanced run_blocking function to display a cancel hint in the UI for better user experience during long-running tasks. - Revised input hints to reflect the new cancel functionality and streamline user instructions.
- Expanded the documentation section in the README to include a detailed table of contents for user-facing documentation. - Added links to various guides covering installation, commands, configuration, providers, tools, sessions, permissions, skills, and advanced topics.
There was a problem hiding this comment.
2 issues found across 12 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/documentation/providers.md">
<violation number="1" location="docs/documentation/providers.md:9">
P2: Documentation defaults for MiniMax are inconsistent with runtime defaults (docs say M2.7, code defaults/aliases are M2.5). Update this file to match current config behavior to avoid misleading setup and alias usage.</violation>
</file>
<file name="docs/documentation/commands.md">
<violation number="1" location="docs/documentation/commands.md:269">
P2: `nca memory` is documented as a valid command, but the CLI requires a memory subcommand (e.g. `list` or `add`).</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
|
|
||
| | Provider | Default Model | API Style | Description | | ||
| |----------|---------------|-----------|-------------| | ||
| | **MiniMax** | `MiniMax-M2.7` | Anthropic-compatible | Primary provider. Uses the MiniMax Anthropic-compatible endpoint. | |
There was a problem hiding this comment.
P2: Documentation defaults for MiniMax are inconsistent with runtime defaults (docs say M2.7, code defaults/aliases are M2.5). Update this file to match current config behavior to avoid misleading setup and alias usage.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/documentation/providers.md, line 9:
<comment>Documentation defaults for MiniMax are inconsistent with runtime defaults (docs say M2.7, code defaults/aliases are M2.5). Update this file to match current config behavior to avoid misleading setup and alias usage.</comment>
<file context>
@@ -0,0 +1,255 @@
+
+| Provider | Default Model | API Style | Description |
+|----------|---------------|-----------|-------------|
+| **MiniMax** | `MiniMax-M2.7` | Anthropic-compatible | Primary provider. Uses the MiniMax Anthropic-compatible endpoint. |
+| **Anthropic** | `claude-3-7-sonnet-latest` | Native Anthropic | Direct Anthropic API for Claude models. |
+| **OpenAI** | `gpt-4o-mini` | OpenAI Chat | Standard OpenAI chat completions API. |
</file context>
| Manage persistent memory notes. | ||
|
|
||
| ```bash | ||
| nca memory [--json] # List memory notes |
There was a problem hiding this comment.
P2: nca memory is documented as a valid command, but the CLI requires a memory subcommand (e.g. list or add).
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/documentation/commands.md, line 269:
<comment>`nca memory` is documented as a valid command, but the CLI requires a memory subcommand (e.g. `list` or `add`).</comment>
<file context>
@@ -0,0 +1,371 @@
+Manage persistent memory notes.
+
+```bash
+nca memory [--json] # List memory notes
+nca memory list [--json] # Same as above
+nca memory add <TEXT> [--kind <KIND>]
</file context>
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 by cubic
Adds comprehensive user docs under docs/documentation and updates README to link to them. Covers install, CLI commands, interactive mode, configuration, providers, tools, sessions, permissions, skills, and advanced topics (sub-agents, MCP, orchestration, memory, IPC, autoresearch, doctor) to give users a complete reference and clearer entry points.
Written for commit c86dd30. Summary will update on new commits.