docs: Add workspace reference for agentic coding#21
Conversation
Update AGENTS.md and README.md to direct AI-assisted development to use the halos-distro workspace for full context across all repos. This follows the pattern established in cockpit-apt PR #51, ensuring Claude Code and other AI assistants have access to complete workspace documentation and development workflows. See halos-distro/docs/ for: - HUMAN_DEVELOPMENT_GUIDANCE.md - IMPLEMENTATION_CHECKLIST.md - DEVELOPMENT_WORKFLOW.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation to guide AI-assisted development by directing developers to use the halos-distro workspace for full context across all repositories.
- Created AGENTS.md with workspace setup instructions and repository overview
- Added "Agentic Coding Setup" section to README.md with workspace clone instructions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| AGENTS.md | New file providing AI assistant guidance, workspace setup, and repository structure documentation |
| README.md | Added section directing developers to use halos-distro workspace for AI-assisted development |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,40 @@ | |||
| ⚠️ **THESE RULES ONLY APPLY TO FILES IN /apt.hatlabs.fi/** ⚠️ | |||
There was a problem hiding this comment.
The path '/apt.hatlabs.fi/' appears inconsistent with typical repository structure. This should likely be clarified or corrected to match the actual repository name or path structure. If this refers to a subdirectory within a workspace, it should be documented more clearly.
| ⚠️ **THESE RULES ONLY APPLY TO FILES IN /apt.hatlabs.fi/** ⚠️ | |
| ⚠️ **THESE RULES ONLY APPLY TO THIS REPOSITORY** ⚠️ |
mairas
force-pushed
the
docs/add-workspace-reference
branch
from
e594147 to
97d30e8
Compare
Add Issue Creation & Implementation and Development Workflow sections to provide comprehensive development guidance. This ensures Claude Code follows structured workflows when working on apt.hatlabs.fi repository tasks.
mairas
force-pushed
the
docs/add-workspace-reference
branch
from
97d30e8 to
b4851ab
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,73 @@ | |||
| ⚠️ **THESE RULES ONLY APPLY TO FILES IN /apt.hatlabs.fi/** ⚠️ | |||
There was a problem hiding this comment.
The path reference /apt.hatlabs.fi/ in this warning is confusing when viewed from within the apt.hatlabs.fi repository itself. When someone opens AGENTS.md directly in this repository, the warning suggests the rules only apply to a subdirectory, which is incorrect. Consider either:
- Removing this warning entirely (since anyone viewing this file is already in this repository)
- Or changing it to something like "
⚠️ THESE RULES APPLY TO THIS REPOSITORY⚠️ " to clarify scope without confusing path references
| ⚠️ **THESE RULES ONLY APPLY TO FILES IN /apt.hatlabs.fi/** ⚠️ | |
| ⚠️ **THESE RULES APPLY TO THIS REPOSITORY** ⚠️ |
Summary
Updates AGENTS.md and README.md to direct AI-assisted development to use the halos-distro workspace for full context across all repositories.
Changes
Rationale
This follows the pattern established in cockpit-apt PR #51. By working from the halos-distro workspace, Claude Code and other AI assistants get access to:
References