Skip to content

Commit 1d0ee28

Browse files
committed
Add internal-docs as private submodule
1 parent 5197711 commit 1d0ee28

File tree

4 files changed

+64
-2
lines changed

4 files changed

+64
-2
lines changed

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,4 @@ dist/
1010
*.swo
1111
*~
1212
.claude
13-
internal-docs/
14-
internal-docs.zip
1513
.codebase-intelligence.json

.gitmodules

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

AGENTS.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Agent Instructions
2+
3+
## Internal Documentation
4+
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:
37+
38+
```bash
39+
git pull
40+
git submodule update --remote
41+
```
42+
43+
To commit changes in the submodule:
44+
45+
```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"
53+
```
54+
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

internal-docs

Submodule internal-docs added at 559dfa0

0 commit comments

Comments
 (0)