Skip to content

Commit f350979

Browse files
Merge pull request #18 from codinit-dev/mintlify/simplify-docs-for-non-technical-users-44965
Pull request for mintlify/simplify-docs-for-non-technical-users-44965
2 parents 811de1f + ddc3fdd commit f350979

File tree

11 files changed

+979
-1410
lines changed

11 files changed

+979
-1410
lines changed
Lines changed: 42 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,68 @@
11
---
22
title: Code Editor Panel
3-
description: Professional code editing environment with syntax highlighting, intelligent file management, and seamless terminal integration.
3+
description: Where you write and organize your code files
44
---
55

6-
The Code Editor Panel serves as your primary workspace for writing, editing, and managing code files. It combines a powerful code editor with intuitive file navigation and terminal integration in a unified interface.
6+
The Code Editor is where you write your code. It's like a super-smart text editor that understands programming and helps you write better code.
77

8-
## Overview
8+
## What is the Code Editor?
99

10-
Designed for modern development workflows, the editor panel provides everything you need for efficient coding: syntax highlighting, intelligent file management, and seamless terminal access. The resizable layout adapts to your preferred working style.
10+
Think of the Code Editor as a special notebook for writing code. It colors your code to make it easier to read and helps you find mistakes.
1111

1212
<CardGroup cols={3}>
13-
<Card title="Code Editing" icon="code">
14-
Advanced editor with syntax highlighting and intelligence
13+
<Card title="Write Code" icon="code">
14+
Type your code with helpful colors and hints
1515
</Card>
16-
<Card title="File Management" icon="folder">
17-
Hierarchical file browsing with advanced operations
16+
<Card title="Organize Files" icon="folder">
17+
See all your project files in a tree
1818
</Card>
19-
<Card title="Terminal Integration" icon="terminal">
20-
Built-in command line access
19+
<Card title="Run Commands" icon="terminal">
20+
Use the terminal without leaving the editor
2121
</Card>
2222
</CardGroup>
2323

24-
## Main Interface
24+
## Main Parts
2525

26-
<AccordionGroup>
27-
<Accordion title="File Navigation" icon="folder-tree">
28-
### Project File Tree
26+
### Finding Your Files
2927

30-
Navigate your project structure with powerful browsing features:
31-
- **Hierarchical display** - Expandable folder structure
32-
- **File type indicators** - Visual icons for different file types
33-
- **Unsaved changes** - Clear indicators for modified files
34-
- **Hidden file filtering** - Automatic exclusion of system files
28+
On the left side, you'll see all your project files organized like folders on your computer:
29+
- Click folders to open them and see what's inside
30+
- Click files to open and edit them
31+
- Icons show you what type of file it is (JavaScript, image, etc.)
32+
- A dot appears next to files you've changed but haven't saved
3533

36-
</Accordion>
34+
### Writing Code
3735

38-
<Accordion title="Code Editor" icon="edit">
39-
### Main Editing Area
36+
The big area in the middle is where you write your code:
37+
- **Colors** - Different parts of your code show up in different colors to make it easier to read
38+
- **Suggestions** - As you type, the editor suggests what you might want to write next
39+
- **Find and replace** - Search for words in your code and change them
40+
- **Multiple spots** - Edit several places at once
4041

41-
Professional code editing with modern features:
42-
- **Syntax highlighting** - Support for all major programming languages
43-
- **Auto-completion** - Intelligent code suggestions
44-
- **Multiple cursors** - Simultaneous editing at multiple locations
45-
- **Find and replace** - Advanced search within files
42+
### Using the Terminal
4643

47-
</Accordion>
44+
At the bottom, you can open a terminal to run commands:
45+
- Open multiple terminal tabs for different tasks
46+
- Make it bigger or smaller by dragging
47+
- See commands you ran before
48+
- Run commands without leaving your code
4849

49-
<Accordion title="Terminal Access" icon="terminal">
50-
### Integrated Command Line
50+
## What You Can Do With Files
5151

52-
Execute commands without leaving your coding environment:
53-
- **Multiple terminal tabs** - Different command sessions
54-
- **Resizable panels** - Adjust terminal size as needed
55-
- **Command history** - Access to previous commands
56-
- **Environment integration** - Full project context
52+
You can manage your files in many ways:
53+
- **Create** - Make new files and folders
54+
- **Delete** - Remove files you don't need
55+
- **Rename** - Change file names
56+
- **Upload** - Drag files from your computer into the editor
57+
- **Search** - Find files quickly by name
5758

58-
</Accordion>
59-
</AccordionGroup>
59+
### Reviewing AI Changes
6060

61-
## File Operations
62-
63-
<BadgeGroup>
64-
<Badge variant="secondary">Create Files/Folders</Badge>
65-
<Badge variant="secondary">Delete/Rename</Badge>
66-
<Badge variant="secondary">Drag & Drop Upload</Badge>
67-
<Badge variant="secondary">File Locking</Badge>
68-
<Badge variant="secondary">Diff Approval</Badge>
69-
</BadgeGroup>
70-
71-
### File Management Features
72-
73-
- **Context menus** - Right-click for quick operations
74-
- **Drag and drop** - Upload files from your computer
75-
- **File locking** - Prevent conflicts in team environments
76-
- **Search integration** - Quick file location
77-
- **Diff approval workflow** - Review and approve AI-generated file changes before applying them
78-
79-
### Diff Approval Workflow
80-
81-
CodinIT now includes an optional diff approval system that lets you review AI-generated changes before they're applied to your files:
82-
83-
- **Visual diff comparison** - See exactly what changes the AI wants to make
84-
- **Side-by-side view** - Compare before and after versions inline
85-
- **Approve or reject** - Full control over which changes get applied
86-
- **Syntax highlighting** - Language-aware diff display for better readability
61+
When the AI wants to change your files, you can review the changes first:
62+
- **See the differences** - Compare the old and new versions side by side
63+
- **Approve or reject** - Choose which changes to keep
64+
- **Colored highlights** - See exactly what's being added or removed
8765

8866
<Callout type="info">
89-
**Enable Diff Approval**: Toggle this feature in Settings → Features to review all AI file changes before they're applied to your project.
67+
**Review Changes**: Turn on diff approval in Settings → Features to check all AI changes before they're saved to your files.
9068
</Callout>

features/development/terminal.mdx

Lines changed: 39 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,94 +1,65 @@
11
---
22
title: Terminal
3-
description: Advanced terminal emulation with full command-line integration, multiple sessions, and seamless project environment access.
3+
description: Type commands to control your project, just like a computer's command line
44
---
55

6-
The Terminal Interface provides a fully-featured command-line environment directly within your development workspace, enabling seamless execution of build commands, package management, and system operations.
6+
The Terminal is like a text-based remote control for your project. Instead of clicking buttons, you type commands to tell your computer what to do.
77

8-
## Overview
8+
## What is the Terminal?
99

10-
Built on XTerm.js, the terminal component offers professional-grade terminal emulation with support for multiple sessions, theming, and interactive command execution. It integrates deeply with your project's environment, providing access to all development tools and scripts.
10+
Think of the Terminal as a way to talk directly to your computer using text commands. It's like texting your computer to ask it to do things.
1111

1212
<CardGroup cols={3}>
13-
<Card title="Command Execution" icon="terminal">
14-
Run build scripts, package managers, and development tools
13+
<Card title="Run Commands" icon="terminal">
14+
Tell your computer what to do by typing
1515
</Card>
16-
<Card title="Session Management" icon="layers">
17-
Multiple terminal tabs for different workflows
16+
<Card title="Multiple Tabs" icon="layers">
17+
Open several terminals at once
1818
</Card>
19-
<Card title="Theme Integration" icon="palette">
20-
Consistent theming with your development environment
19+
<Card title="See Results" icon="palette">
20+
Watch what happens when you run commands
2121
</Card>
2222
</CardGroup>
2323

24-
## Key Features
24+
## What Can You Do?
2525

26-
<AccordionGroup>
27-
<Accordion title="Terminal Emulation" icon="monitor">
28-
### Advanced Terminal Capabilities
26+
### Running Commands
2927

30-
Professional terminal emulation supporting:
31-
- **Full ANSI escape sequences** - Rich text formatting and colors
32-
- **Mouse support** - Interactive terminal applications
33-
- **Unicode support** - International character display
34-
- **Web links** - Clickable URLs in terminal output
28+
You can type commands to:
29+
- Start your app so you can see it working
30+
- Install new tools and libraries
31+
- Check if your code has any problems
32+
- Save your work to GitHub
3533

36-
</Accordion>
34+
### Common Commands
3735

38-
<Accordion title="Environment Integration" icon="cog">
39-
### Project Environment Access
36+
Here are some commands you might use:
37+
- `npm install` - Download tools your project needs
38+
- `npm start` - Start your app
39+
- `npm test` - Check if everything works correctly
40+
- `git status` - See what files you've changed
4041

41-
Complete access to your development environment:
42-
- **Project directory** - Automatic navigation to workspace
43-
- **Environment variables** - Access to configured variables
44-
- **Installed tools** - Node.js, npm, git, and other tools
45-
- **File permissions** - Full read/write access to project files
42+
### Using Multiple Terminals
4643

47-
</Accordion>
44+
You can open several terminal tabs at once, like having multiple conversations:
45+
- One tab runs your app
46+
- Another tab runs tests
47+
- A third tab is ready for quick commands
4848

49-
<Accordion title="Interactive Features" icon="zap">
50-
### Enhanced User Experience
49+
This way, you don't have to stop one thing to do another.
5150

52-
Modern terminal features for improved productivity:
53-
- **Command history** - Navigate through previous commands
54-
- **Auto-completion** - Intelligent command suggestions
55-
- **Search functionality** - Find text within terminal output
56-
- **Copy/paste support** - Standard clipboard operations
57-
- **Live action console** - Real-time streaming output for running commands
51+
### Helpful Features
5852

59-
</Accordion>
53+
The terminal has some handy tricks:
54+
- **Command history** - Press the up arrow to see commands you typed before
55+
- **Copy and paste** - Copy text in and out of the terminal
56+
- **Search** - Find specific text in the terminal output
57+
- **Live updates** - See results appear as they happen
6058

61-
<Accordion title="Live Action Console" icon="activity">
62-
### Real-Time Command Monitoring
63-
64-
Monitor command execution with live streaming output:
65-
- **Real-time output** - See command output as it happens
66-
- **Progress tracking** - Visual progress indicators for long-running tasks
67-
- **Command context** - Know which command is currently executing
68-
- **Streaming display** - Continuous output updates without page refresh
69-
70-
<Callout type="info">
71-
**Enable Live Console**: Toggle this feature in Settings → Features to see real-time command output in a floating console.
72-
</Callout>
73-
74-
</Accordion>
75-
</AccordionGroup>
76-
77-
## Usage Modes
78-
79-
<BadgeGroup>
80-
<Badge variant="secondary">Read-Write Mode</Badge>
81-
<Badge variant="secondary">Read-Only Mode</Badge>
82-
<Badge variant="secondary">Background Execution</Badge>
83-
</BadgeGroup>
84-
85-
### Terminal States
86-
87-
- **Active Session** - Full command execution and interaction
88-
- **Read-Only** - Output display without input capability
89-
- **Background** - Commands running without visible interface
59+
<Callout type="info">
60+
**Live Console**: Turn on the live console in Settings → Features to see command results in a floating window while you work.
61+
</Callout>
9062

9163
<Callout type="tip">
92-
**Pro Tip**: Use multiple terminal tabs to run development servers, build processes, and testing simultaneously
93-
without switching contexts.
64+
**Quick Tip**: Open multiple terminal tabs to run your app in one tab while typing other commands in another tab.
9465
</Callout>
Lines changed: 28 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,53 @@
11
---
22
title: WebContainer
3-
description: Manage multiple development server instances with seamless port switching and real-time preview management for complex applications.
3+
description: Switch between different parts of your app while it's running
44
---
55

6-
Manage multiple development server instances running in WebContainer environments. The port dropdown provides seamless switching between different preview instances and server configurations.
6+
WebContainer lets you run your app and see it working. If your app has multiple parts (like a website and a backend), you can easily switch between them.
77

8-
## Overview
8+
## What is WebContainer?
99

10-
When running multiple development servers or microservices, the WebContainer Preview Management system allows you to switch between different application instances with a simple dropdown interface.
10+
Think of WebContainer like a mini computer inside CodinIT. It runs your code and shows you what it looks like, just like opening a website in your browser.
1111

1212
<CardGroup cols={3}>
13-
<Card title="Port Selection" icon="hash">
14-
Quick switching between server instances
13+
<Card title="Switch Views" icon="hash">
14+
Jump between different parts of your app
1515
</Card>
16-
<Card title="Instance Management" icon="server">
17-
Multiple preview environments
16+
<Card title="Multiple Parts" icon="server">
17+
Run several things at once
1818
</Card>
19-
<Card title="Status Indicators" icon="activity">
20-
Active preview identification
19+
<Card title="See What's Active" icon="activity">
20+
Know which part you're looking at
2121
</Card>
2222
</CardGroup>
2323

24-
## Preview Management
24+
## How to Use It
2525

26-
<AccordionGroup>
27-
<Accordion title="Port Organization" icon="list-ordered">
26+
### Switching Between Parts
2827

29-
### Server Instance Selection
28+
When your app is running, you might see different "ports" (think of them as different doors to your app). You can click a dropdown to switch between them.
3029

31-
Organized access to all running preview instances:
32-
- **Port-based sorting** - Numerical ordering of available ports
33-
- **Active indication** - Clear highlighting of current preview
34-
- **Quick switching** - One-click navigation between instances
35-
- **Instance persistence** - Maintains selection across sessions
30+
- Click the port number to see all available parts
31+
- Select the one you want to view
32+
- Your preview updates instantly
3633

37-
</Accordion>
34+
### When You Need Multiple Parts
3835

39-
<Accordion title="Multi-Server Support" icon="network">
36+
Some apps have different pieces that work together:
4037

41-
### Complex Application Management
38+
- **Website** - What users see and click on
39+
- **Backend** - The part that handles data and logic
40+
- **Tools** - Extra helpers for testing or building
4241

43-
Handle applications with multiple server components:
44-
- **Frontend servers** - Main application interfaces
45-
- **API servers** - Backend service endpoints
46-
- **Development tools** - Additional development servers
47-
- **Microservices** - Individual service previews
42+
You can view each part separately to make sure everything works correctly.
4843

49-
</Accordion>
44+
### Navigating Your App
5045

51-
<Accordion title="Navigation Integration" icon="link">
52-
53-
### Address Bar Integration
54-
55-
Seamlessly integrated with preview navigation:
56-
- **URL path support** - Navigate within selected instance
57-
- **Port preservation** - Maintains port context during navigation
58-
- **Reload functionality** - Refresh current preview instance
59-
- **External access** - Open previews in new tabs/windows
60-
61-
</Accordion>
62-
</AccordionGroup>
63-
64-
## Usage Scenarios
65-
66-
<BadgeGroup>
67-
<Badge variant="secondary">Full-Stack Apps</Badge>
68-
<Badge variant="secondary">Microservices</Badge>
69-
<Badge variant="secondary">Multi-Tenant Apps</Badge>
70-
<Badge variant="secondary">Development Tools</Badge>
71-
</BadgeGroup>
72-
73-
### Common Use Cases
74-
75-
- **Full-stack applications** - Frontend and backend servers
76-
- **Microservice architectures** - Multiple service endpoints
77-
- **Development tooling** - Build tools, testing servers
78-
- **Multi-environment** - Different configurations
46+
Once you pick a part to view:
47+
- Type URLs in the address bar to visit different pages
48+
- Click the refresh button to reload
49+
- Open in a new tab to see it in your regular browser
7950

8051
<Callout type="info">
81-
**Port Management**: The port dropdown automatically detects and lists all available WebContainer preview instances,
82-
making it easy to switch between different parts of your application during development.
52+
**Easy Switching**: CodinIT automatically finds all the running parts of your app. Just pick the one you want to see from the dropdown menu.
8353
</Callout>

0 commit comments

Comments
 (0)