Skip to content

Commit bb5dcb1

Browse files
committed
Update submodule to codebase-context-internal and simplify docs
1 parent 1d0ee28 commit bb5dcb1

File tree

2 files changed

+12
-50
lines changed

2 files changed

+12
-50
lines changed

.gitmodules

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
[submodule "internal-docs"]
22
path = internal-docs
3-
url = https://github.com/PatrickSys/codebase-context-mcp-internal.git
3+
url = https://github.com/PatrickSys/codebase-context-internal.git
4+

AGENTS.md

Lines changed: 10 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,21 @@
11
# Agent Instructions
22

33
## Internal Documentation
4+
This repository uses a private git submodule for internal notes.
45

5-
This repository uses a **git submodule** for internal documentation:
6-
7-
- **Submodule path**: `internal-docs/`
8-
- **Private repository**: `PatrickSys/codebase-context-mcp-internal`
9-
- **Purpose**: Store internal research, strategies, and private development notes
10-
11-
### Initial Setup (New Machine)
12-
13-
When cloning this repository for the first time:
14-
15-
```bash
16-
git clone https://github.com/PatrickSys/codebase-context-mcp.git
17-
cd codebase-context-mcp
18-
git submodule init
19-
git submodule update
20-
```
21-
22-
Or use the shorthand:
23-
24-
```bash
25-
git clone --recurse-submodules https://github.com/PatrickSys/codebase-context-mcp.git
26-
```
27-
28-
### Authentication
29-
30-
The submodule repository is **private**. Ensure you have:
31-
- A valid GitHub Personal Access Token (PAT) with `repo` scope, OR
32-
- SSH keys configured for GitHub access
33-
34-
### Syncing Changes
35-
36-
To pull latest changes from both main and submodule repositories:
6+
- **Path**: `internal-docs/`
7+
- **Repo**: `https://github.com/PatrickSys/codebase-context-internal.git`
378

9+
### Quick Setup
3810
```bash
39-
git pull
40-
git submodule update --remote
11+
git clone --recurse-submodules https://github.com/PatrickSys/codebase-context.git
4112
```
4213

43-
To commit changes in the submodule:
44-
14+
### Syncing
4515
```bash
46-
cd internal-docs
47-
git add .
48-
git commit -m "your message"
49-
git push origin main
50-
cd ..
51-
git add internal-docs
52-
git commit -m "Update submodule reference"
16+
git pull --recurse-submodules
17+
git submodule update --remote --merge
5318
```
5419

55-
### Why a Submodule?
56-
57-
- **Privacy**: Keeps internal docs in a separate private repository
58-
- **Sync**: Enables synchronization across multiple machines
59-
- **Version Control**: Tracks internal docs alongside public code
60-
- **Security**: CrowdStrike restrictions prevent USB transfers; GitHub provides secure cloud sync
20+
### Privacy & Security
21+
The `internal-docs` repository is **Private**. It returns a 404 to unauthenticated users/APIs. Access requires a GitHub PAT or SSH keys with repository permissions.

0 commit comments

Comments
 (0)