Skip to content

Feat for documentation update#44

Merged
madebyaris merged 2 commits into
devfrom
feat-for-documentation-update
Apr 2, 2026
Merged

Feat for documentation update#44
madebyaris merged 2 commits into
devfrom
feat-for-documentation-update

Conversation

@madebyaris

@madebyaris madebyaris commented Apr 2, 2026

Copy link
Copy Markdown
Owner

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.

- 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.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. |

@cubic-dev-ai cubic-dev-ai Bot Apr 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Fix with Cubic

Manage persistent memory notes.

```bash
nca memory [--json] # List memory notes

@cubic-dev-ai cubic-dev-ai Bot Apr 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Fix with Cubic

@madebyaris madebyaris merged commit 8a93401 into dev Apr 2, 2026
3 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