Files
ai-prompts/README.md

80 lines
2.0 KiB
Markdown

# AI Prompts & Rules Repository
Public repository of AI prompt rules, context files, and briefing documents
organised by project. Any AI or server can read these files directly.
**Hosted at:** https://g.pozi.co.za/gadmin/ai-prompts
**Owner:** Richard Brandon <richard@teacup.co.za>
**Access:** Public read-only. Authenticated write via API token.
---
## How to Use (for AIs and scripts)
### Clone the whole repo
```bash
git clone https://g.pozi.co.za/gadmin/ai-prompts.git
```
### Fetch a single file without cloning
```bash
curl https://g.pozi.co.za/gadmin/ai-prompts/raw/branch/main/PROJECT/filename.md
```
### Pull latest updates into an existing clone
```bash
cd ai-prompts && git pull origin main
```
---
## Folder Structure
```
ai-prompts/
├── README.md ← this file
├── CONTRIBUTING.md ← how to add new prompt files (read this)
├── gitea-server/ ← prompts about this Gitea server setup
│ ├── server-briefing.md
│ ├── client-ssh-setup.md
│ └── new-server-onboarding.md
├── multiplan/ ← Multiplan PHP ERP project
│ └── deployment-pipeline.md
├── dotfiles/ ← desktop/laptop dotfiles management
│ └── dotfiles-setup.md
├── arduino/ ← Arduino projects and scripting
└── general/ ← general-purpose AI rules and prompts
└── git-conventions.md
```
---
## File Naming Convention
```
PROJECT/
context-briefing.md ← what this project IS (give to AI at session start)
setup-THING.md ← how to set something up
rules-THING.md ← rules/constraints AI must follow
prompt-TASK.md ← prompt to give AI to perform a specific task
```
---
## Raw File URLs
All files are accessible as raw text at:
```
https://g.pozi.co.za/gadmin/ai-prompts/raw/branch/main/<folder>/<file>
```
Example:
```bash
curl https://g.pozi.co.za/gadmin/ai-prompts/raw/branch/main/gitea-server/server-briefing.md
```