Skip to content

Feature/docs#5

Merged
cnjack merged 3 commits into
mainfrom
feature/docs
Apr 15, 2026
Merged

Feature/docs#5
cnjack merged 3 commits into
mainfrom
feature/docs

Conversation

@cnjack

@cnjack cnjack commented Apr 15, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

Release Notes

  • Documentation

    • Launched comprehensive documentation site with guides covering configuration, getting started, commands, and feature overviews.
    • Added detailed documentation for core features: agent teams, plan mode, sessions, skills, SSH remote work, MCP integration, and web interface.
    • Added tool reference documentation covering file operations, search, task management, and command execution.
  • Updates

    • Updated CLI command syntax in README from flag-based to subcommand format.
    • Added new keyboard shortcuts: Ctrl+L for model picker, Ctrl+T for team panel toggle.
    • Updated MCP configuration schema field naming.

cnjack added 3 commits April 15, 2026 03:11
- Add Jekyll-based docs site (docs-site/) with Just the Docs theme
- Write 16 documentation pages covering all major features:
  overview, agent, models, tools, subagents, skills, agent teams,
  plan mode, SSH, sessions, context/memory, MCP, web UI,
  configuration, commands & shortcuts
- Add GitHub Actions workflow for GitHub Pages deployment
- Update README with new tagline, slogans, and documentation link
- Style follows Trae docs pattern: user-perspective, task-oriented
- Rename docs-site/ to docs/ for GitHub Pages branch deployment
- Move internal design docs from docs/ to internal-docs/
- Add webrick gem dependency
- Remove GitHub Actions workflow (not needed for branch deployment)
…te configuration for theme and search features
@cnjack cnjack merged commit a463d48 into main Apr 15, 2026
2 of 4 checks passed
@cnjack cnjack deleted the feature/docs branch April 15, 2026 03:27
@coderabbitai

coderabbitai Bot commented Apr 15, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 682d98ee-24c0-45ce-85a2-d2c7610a9de4

📥 Commits

Reviewing files that changed from the base of the PR and between 2187e46 and da4f985.

⛔ Files ignored due to path filters (1)
  • docs/Gemfile.lock is excluded by !**/*.lock
📒 Files selected for processing (84)
  • .github/workflows/pages.yml
  • .gitignore
  • README.md
  • docs/Gemfile
  • docs/_config.yml
  • docs/commands.md
  • docs/configuration.md
  • docs/get-started.md
  • docs/index.md
  • docs/overview.md
  • docs/overview/agent-teams.md
  • docs/overview/agent.md
  • docs/overview/context-memory.md
  • docs/overview/mcp.md
  • docs/overview/models.md
  • docs/overview/plan-mode.md
  • docs/overview/sessions.md
  • docs/overview/skills.md
  • docs/overview/ssh.md
  • docs/overview/subagents.md
  • docs/tools.md
  • docs/tools/execute.md
  • docs/tools/file-tools.md
  • docs/tools/search-tools.md
  • docs/tools/task-management.md
  • docs/web-interface.md
  • internal-docs/analyse/agent_loop.md
  • internal-docs/analyse/permission_system.md
  • internal-docs/analyse/prompt_system.md
  • internal-docs/analyse/skills.md
  • internal-docs/analyse/subagent.md
  • internal-docs/analyse/tools_ask_user.md
  • internal-docs/analyse/tools_edit_read.md
  • internal-docs/analyse/tools_execute.md
  • internal-docs/analyse/tools_grep.md
  • internal-docs/analyse/tools_mcp.md
  • internal-docs/analyse/tools_todo.md
  • internal-docs/design/acceptance_criteria.md
  • internal-docs/design/agent_loop/design.md
  • internal-docs/design/agent_loop_enhancements/design.md
  • internal-docs/design/agent_team/design.md
  • internal-docs/design/agents/architect.md
  • internal-docs/design/autonomous_env_switching/agent.md
  • internal-docs/design/autonomous_env_switching/ui.md
  • internal-docs/design/claude_code_comparison/analysis.md
  • internal-docs/design/context_management.md
  • internal-docs/design/conversation_storage/design.md
  • internal-docs/design/draft/task_summary_and_observability.md
  • internal-docs/design/environment_awareness.md
  • internal-docs/design/exit_confirmation.md
  • internal-docs/design/hitl_approval/design.md
  • internal-docs/design/middleware_pipeline.md
  • internal-docs/design/permission_system/design.md
  • internal-docs/design/plan.md
  • internal-docs/design/plan_agent_collab/design.md
  • internal-docs/design/plan_mode.md
  • internal-docs/design/prompt_system/design.md
  • internal-docs/design/skills/design.md
  • internal-docs/design/subagent.md
  • internal-docs/design/subagent_v2/design.md
  • internal-docs/design/system_reminders.md
  • internal-docs/design/tools_v2/acceptance_criteria.md
  • internal-docs/design/tools_v2/architecture.md
  • internal-docs/design/tools_v2/ask_user_tool_v2.md
  • internal-docs/design/tools_v2/common_components.md
  • internal-docs/design/tools_v2/dependencies.md
  • internal-docs/design/tools_v2/design.md
  • internal-docs/design/tools_v2/edit_read_write_tool_v2.md
  • internal-docs/design/tools_v2/execute_tool_v2.md
  • internal-docs/design/tools_v2/grep_tool.md
  • internal-docs/design/tools_v2/grep_tool_v2.md
  • internal-docs/design/tools_v2/implementation_plan.md
  • internal-docs/design/tools_v2/mcp_tool_v2.md
  • internal-docs/design/tools_v2/risk_assessment.md
  • internal-docs/design/tools_v2/storage_layer.md
  • internal-docs/design/tools_v2/todo_tool_v2.md
  • internal-docs/design/tools_v2/tui_v2.md
  • internal-docs/design/ui/ui.md
  • internal-docs/prd/agent_loop.md
  • internal-docs/prd/permission_system.md
  • internal-docs/prd/prompt_system.md
  • internal-docs/prd/skills.md
  • internal-docs/prd/subagent.md
  • internal-docs/prd/tools.md

📝 Walkthrough

Walkthrough

These changes establish a comprehensive Jekyll-based documentation site for jcode, including CI/CD automation for GitHub Pages deployment, Ruby gem dependencies, site configuration, and extensive documentation covering product overview, CLI commands, configuration, tools, features, and web interface.

Changes

Cohort / File(s) Summary
GitHub Pages & Jekyll Setup
.github/workflows/pages.yml, .gitignore, docs/Gemfile, docs/_config.yml
Adds Jekyll-based documentation site infrastructure with GitHub Actions workflow for Pages deployment, Ruby gem dependencies (just-the-docs, jemoji, webrick), and Jekyll configuration with theme, plugins, callout styles, and UI settings.
Product Documentation
README.md, docs/index.md, docs/get-started.md
Updates product messaging, CLI examples (flag-based to subcommand syntax), and navigation links in README; adds landing page with features/comparison table; provides complete getting-started guide with prerequisites, installation, setup wizard flow, and build instructions.
Concept & Architecture Documentation
docs/overview.md, docs/overview/agent.md, docs/overview/agent-teams.md, docs/overview/context-memory.md, docs/overview/plan-mode.md, docs/overview/sessions.md, docs/overview/skills.md, docs/overview/subagents.md, docs/overview/ssh.md
Comprehensive documentation of jcode's core features including agent control flow, team coordination, context/memory management with AGENTS.md customization, plan mode workflow, session persistence and resumption, custom skills framework, subagent delegation, and SSH/remote work capabilities.
Provider & Configuration Documentation
docs/overview/models.md, docs/overview/mcp.md, docs/configuration.md
Documents model provider configuration with OpenAI-compatible API support, MCP server integration with supported connection types, and detailed configuration file reference with field descriptions, examples, and directory layout diagram.
Tool & Interface Documentation
docs/tools.md, docs/tools/execute.md, docs/tools/file-tools.md, docs/tools/search-tools.md, docs/tools/task-management.md, docs/commands.md, docs/web-interface.md
Details all built-in tools (file read/edit/write, grep/glob search, task management, execution), CLI commands and keyboard shortcuts, approval policies, and web interface features with REST API endpoints for chat, sessions, settings, and terminal access.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~18 minutes

Poem

🐰 A documentation garden blooms,
Jekyll weaves through GitHub's rooms,
Pages deploy with every push,
No more searching in a rush—
Features, tools, and guides so clear,
jcode's story now lives here! 🌱

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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