Skip to content

Commit 0abd74c

Browse files
committed
feat: add starting docs for git
1 parent 05e4530 commit 0abd74c

File tree

9 files changed

+37
-2
lines changed

9 files changed

+37
-2
lines changed

docs/07-Features/11-Git.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,41 @@
22
title: Git
33
---
44

5-
Explore Git Features in Phoenix Code
5+
**Phoenix Code** includes built-in Git support, allowing you to manage version control directly within the editor. Git can be accessed from the toolbar icon or the File menu in the menu bar.
6+
7+
![Git Overview](../images/git-images/git-overview.png "Git Overview")
8+
9+
> To use Git features inside Phoenix Code, ensure Git is installed on your computer. [Download Git](https://git-scm.com/downloads)
10+
11+
Note: *For projects without an existing Git repository, the Git icon won’t appear by default. To initialize or connect a Git repository, use the File menu to set up Git for your project.*
12+
13+
The Git Panel in **Phoenix Code** provides a simple interface for managing version control. It allows you to track changes, commit updates, interact with remote repositories and many more without leaving the editor.
14+
15+
![Git Panel](../images/git-images/git-panel.png "Git Panel")
16+
17+
18+
## Initializing a Git repository
19+
20+
To initialize a Git repository in a project that doesn’t already have one, click on `File > Git > Init`. This will set up Git for your current project. After initialization, the Git icon will appear in the toolbar, indicating that version control is active.
21+
22+
![Git Init](../images/git-images/git-init.png "Git Init")
23+
24+
25+
## Cloning a Git repository
26+
27+
If you want to clone an existing project, you can do so directly within the editor. To clone a repository, go to `File > Git > Clone`. A dialog will appear, prompting you to enter the URL of the repository you wish to clone.
28+
29+
![Git Clone](../images/git-images/git-clone-dialog.png "Git Clone")
30+
31+
### More Options
32+
33+
In the Clone Repository dialog, clicking on `More Options` expands additional settings for authentication.
34+
35+
![Git Clone More options](../images/git-images/git-clone-more-options.png "Git Clone more options")
36+
37+
**Credentials**: This section allows you to enter your *username* and *password* for repositories that require authentication. Typically, if your credentials are already stored in a credential manager (like SSH keys or a Git credential manager), you don't need to fill in these fields.
38+
39+
**Save Credentials to Remote URL**: If enabled, the provided credentials (username and password) will be stored in plain text within the remote URL.
40+
41+
*If cloning fails due to authentication issues (e.g., timeout errors), you might need to manually provide your credentials.*
642

7-
Coming soon...
42.4 KB
Loading
19.8 KB
Loading
49.1 KB
Loading
113 KB
Loading
21.6 KB
Loading
119 KB
Loading
285 KB
Loading
203 KB
Loading

0 commit comments

Comments
 (0)