67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
# Contributing
|
|
|
|
This file contains the prompt and setup info for adding new guides via Claude.
|
|
|
|
## Prompt for new chat
|
|
|
|
```
|
|
I have a guides repo on my self-hosted Forgejo instance. Here's everything
|
|
you need to work with it directly.
|
|
|
|
## Git setup
|
|
|
|
Remote: git@vps-forgejo-01.warthog-rockhopper.ts.net:egeidal/guides.git
|
|
Local folder: ~/guides
|
|
SSH config for Forgejo is already in ~/.ssh/config — port 22, key ~/.ssh/id_rsa
|
|
Git identity: Einar / me@ege.cx
|
|
|
|
## Workflow rules — follow these strictly, no exceptions
|
|
|
|
1. Always show me the full content of any new guide before writing anything
|
|
2. Wait for explicit confirmation before writing or pushing anything
|
|
3. When adding a new guide, also update README.md to include a link and
|
|
one-line description — show me that too before writing
|
|
4. Commit each file separately with a clear message
|
|
5. Never run multiple destructive steps in a single command without confirmation
|
|
|
|
## Repo structure
|
|
|
|
Flat — all guides are .md files in the root. README.md links to all of them.
|
|
|
|
Current guides:
|
|
- git.md — version control basics
|
|
- markdown.md — Markdown syntax reference
|
|
- rclone.md — file syncing, SFTP remotes, SSH key auth
|
|
|
|
## Guide format
|
|
|
|
Each guide follows this structure:
|
|
1. What is it — short intro, mental model if relevant
|
|
2. What it is mainly used for — bullet list
|
|
3. Installation — if applicable
|
|
4. Core concepts / configuration — whatever is relevant to the tool
|
|
5. Core commands with examples — real, practical examples not toy ones
|
|
6. Useful flags — table format
|
|
7. Notes — gotchas, opinions, things that bit me in practice
|
|
|
|
Tone: direct, practical, no padding. Examples should be real where possible
|
|
(my actual hostnames, paths, and use cases are fine to use).
|
|
|
|
## Tools available to you
|
|
|
|
- Desktop Commander write_file — write to /tmp/ on my Mac
|
|
- Control your Mac osascript — run shell commands on my Mac
|
|
- SSH access to vps-hetzner-01.warthog-rockhopper.ts.net as egeidal
|
|
- Tailnet: warthog-rockhopper.ts.net
|
|
|
|
## To add a new guide
|
|
|
|
1. Write the guide content and show it to me
|
|
2. Wait for confirmation
|
|
3. Write it to /tmp/<toolname>.md via Desktop Commander
|
|
4. Update README.md and show me the new entry
|
|
5. Wait for confirmation
|
|
6. cp /tmp/<toolname>.md ~/guides/<toolname>.md
|
|
7. cp /tmp/README.md ~/guides/README.md
|
|
8. git add, commit, push from ~/guides
|
|
```
|