Skip to content

docs: project setup — agent-skills & agent-workspace #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
surrealwolf merged 1 commit into from
Aug 2, 2026
Merged

docs: project setup — agent-skills & agent-workspace #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ Organization profile and community files for [DataKnifeAI](https://github.com/Da
| [`profile/assets/`](profile/assets/) | Org logo assets (1024 header + 384/512 upload sizes) |
| [`docs/ORG_BRANDING.md`](docs/ORG_BRANDING.md) | Canonical mission, profile copy, and avatar guidance |
| [`docs/NAMING.md`](docs/NAMING.md) | Repository naming for the agent pipeline (descriptive vs evocative; upstream integrations) |
| [`docs/PROJECT_SETUP.md`](docs/PROJECT_SETUP.md) | For new/existing projects: review [agent-skills](https://github.com/DataKnifeAI/agent-skills) and [agent-workspace](https://github.com/DataKnifeAI/agent-workspace) |

The profile README displays the **1024×1024** logo only. Smaller PNGs are retained for GitHub/GitLab avatar upload—see the branding doc.
2 changes: 2 additions & 0 deletions docs/ORG_BRANDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Canonical **organization** identity for DataKnifeAI (GitHub org / GitLab group).

Repository naming (pipeline layers, descriptive vs evocative, upstream integrations): [NAMING.md](./NAMING.md).

Shared agent baselines for projects: [PROJECT_SETUP.md](./PROJECT_SETUP.md) ([agent-skills](https://github.com/DataKnifeAI/agent-skills), [agent-workspace](https://github.com/DataKnifeAI/agent-workspace)).

## Mission

Learn and solve problems by leveraging AI tools so the work stays maintainable and runs reliably through automation—preferring open software that respects freedom.
Expand Down
24 changes: 24 additions & 0 deletions docs/PROJECT_SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Project setup — agent skills & workspace

For **new and existing** DataKnifeAI repositories: review these shared baselines before inventing project-local Cursor skills or Cloud Agent layouts.

Keep this page short. Install steps and skill content live in the linked repos.

## Review checklist

| Resource | When to review | What you get |
|----------|----------------|--------------|
| [`DataKnifeAI/agent-skills`](https://github.com/DataKnifeAI/agent-skills) | Adding Cursor/agent skills, or before writing a one-off skill in a product repo | Shared CLI/workflow skills (`gh`, `glab`, `kubectl`, …); install via Makefile / `install-skills.sh` |
| [`DataKnifeAI/agent-workspace`](https://github.com/DataKnifeAI/agent-workspace) | Standing up Cursor Cloud Agents (managed or self-hosted), or a Coder multi-repo workspace | Git baseline with `agent-skills` as a submodule, hooks placeholder, Coder layout rules |

## Guidance

1. **Prefer shared skills** — If a skill is useful beyond one repo, add or extend it in `agent-skills` instead of duplicating under `.cursor/skills/` in the product repo.
2. **Cloud Agent / pool baseline** — Use `agent-workspace` (clone or fork) as the Cloud Agent git root when you need org skills + hooks without stuffing them into every application repo. Init submodules after clone.
3. **Product repos stay focused** — Application code stays in its own repo; optional thin project skills only when they are truly product-specific.
4. **Align with org docs** — Branding and naming live in this `.github` docs set ([ORG_BRANDING](./ORG_BRANDING.md), [NAMING](./NAMING.md); repository settings guidelines when merged).

## Out of scope here

- Full install commands, skill authoring, or Cloud Agent pool ops — see each repo’s README.
- Bulk-changing every product repo to vendor `agent-skills`; adopt when a project actually needs shared skills or a Cloud Agent baseline.
9 changes: 9 additions & 0 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ The name nods lightly to a tool for getting into systems—applied here to AI de
| **GitOps + infra** | Repeatable cluster and platform delivery that agents (and humans) can trust |
| **Local + API models** | Run where it fits—self-hosted inference when you want agency, cloud APIs when you want reach |

## For new and existing projects

Before inventing project-local Cursor skills or Cloud Agent layouts, review the shared baselines:

- **[agent-skills](https://github.com/DataKnifeAI/agent-skills)** — shared Cursor skills for the org
- **[agent-workspace](https://github.com/DataKnifeAI/agent-workspace)** — Cloud Agent / Coder workspace baseline (vendors `agent-skills`)

Short checklist: [PROJECT_SETUP.md](https://github.com/DataKnifeAI/.github/blob/main/docs/PROJECT_SETUP.md).

## Featured projects

### Agent pipeline & control plane
Expand Down