Skip to content

Commit dea9626

Browse files
authored
Merge pull request #602 from unoplat/docs-update
feat: docs up to date
2 parents 70f3ead + 23b8f2e commit dea9626

17 files changed

+9418
-33711
lines changed

code-confluence/docs/quickstart/how-to-run.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,44 +56,46 @@ Follow these steps to set up Code Confluence:
5656
- When prompted, enter a GitHub PAT with read access to the repositories you want to ingest.
5757
- This is required for Code Confluence to clone and analyze your repositories.
5858

59-
![Enter GitHub PAT Token](../../static/github_pat_token.png)
59+
![Enter GitHub PAT Token](../../static/new_github_token.png)
6060

6161
:::tip Getting a GitHub PAT
6262
If you don't have a GitHub PAT:
63-
1. Go to GitHub Settings → Developer Settings → Personal Access Tokens → Tokens (classic)
64-
2. Click "Generate new token (classic)"
65-
3. Give it a name like "CodeConfluence"
66-
4. Select only the `repo` scope (this gives read access to repositories)
67-
5. Click "Generate token" and copy it
63+
1. Click "Generate new token on github (classic)"
64+
2. Click "Generate token" and copy it in the dialog box.
6865

69-
You only need read access since we'll just be cloning repositories!
7066
:::
7167

7268
### 3. Search for a Repository
7369
- Press **`s`** or **`S`** (Shift + s) to open the search dialog.
7470
- You can search through your personal, public, and open source repositories.
7571

76-
![Search for Repository](../../static/search_repo.png)
72+
***![Search for Repository](../../static/repository_search.png)
7773

7874
### 4. Ingest a Repository
7975
- In the **Actions** column, click on **Ingest Repo** for the repository you want to analyze.
8076

81-
![Ingest Repo Action](../../static/ingest_repo_action.png)
77+
![Ingest Repo Action](../../static/repository_ingest_action.jpeg)
8278

8379
### 5. Configure Repository & Codebase
84-
- A Repository Dialog Configuration will open up where you can add one or more codebases for that repo.
85-
- For each codebase, fill in the following:
86-
- **Root Package**: Path to root package/module where the main file for the codebase is situated
87-
- **Codebase Folder**: Folder for codebase within the mono repo (check "No subdirectory" if codebase lives in the repository root)
88-
- **Package Manager**: Select the package manager
89-
- **Programming Language**: Currently only Python is supported
80+
- A Repository Dialog Configuration will open up with automatic codebase detection capabilities.
81+
- Code Confluence will automatically detect Python projects and their main directories within the repository.
9082

91-
#### Example: Configuring CrewAI
92-
For example, to ingest the popular agent framework CrewAI:
83+
![Automatic Codebase Detection](../../static/automatic_code_base_detection.png)
9384

94-
![CrewAI Configuration Example](../../static/codebase_configuration.png)
85+
- You can choose to **Detect Codebases Automatically** (recommended) or configure manually if needed.
86+
- The automatic detection will analyze the repository structure and suggest appropriate configurations for:
87+
- **Root Packages**: Automatically identified main modules/packages
88+
- **Codebase Folders**: Detected project directories
89+
- **Package Manager**: Automatically detected (e.g., uv, pip, poetry)
90+
- **Programming Language**: Currently supports Python
9591

96-
- Once done, click **Submit** to start the ingestion process.
92+
#### Example: Automatic Detection Results
93+
When automatic detection completes, you'll see the detected codebases:
94+
95+
![Automatically Detected Codebases](../../static/codebase_automatic_detected.png)
96+
97+
- Review the automatically detected configurations and make any necessary adjustments.
98+
- Once satisfied with the detection results, click **Submit Repo** to start the ingestion process.
9799

98100
### 6. Enable Developer Mode
99101
- Navigate to **Settings > Developer Mode**, and toggle the switch on to unlock infrastructure tooling.

0 commit comments

Comments
 (0)