Skip to content

docs: add authoring agent instructions guide#286

Merged
Paveltarno merged 1 commit intomainfrom
docs/authoring-agent-instructions
Feb 23, 2026
Merged

docs: add authoring agent instructions guide#286
Paveltarno merged 1 commit intomainfrom
docs/authoring-agent-instructions

Conversation

@Paveltarno
Copy link
Collaborator

@Paveltarno Paveltarno commented Feb 22, 2026

Note

Description

This PR adds a new topic guide, docs/authoring-agent-instructions.md, covering best practices for writing Claude Code skills, CLAUDE.md project instructions, AGENTS.md files, and subagent definitions. It also registers the new guide in docs/AGENTS.md alongside the existing topic guide index so it is discoverable by both humans and AI agents.

Related Issue

None

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Other (please describe):

Changes Made

  • Added docs/authoring-agent-instructions.md (154 lines) — new topic guide covering:
    • CLAUDE.md structure, what to include/exclude, and anti-patterns
    • Skill authoring: frontmatter schema (name, description), body guidelines, and progressive disclosure levels
    • Bundled resource conventions (scripts/, references/, assets/)
    • Subagent definitions (.claude/agents/) format and a skills-vs-subagents comparison table
    • Pre-ship checklist for any instruction file
  • Updated docs/AGENTS.md to add a link entry for the new guide in the topic guide index

Testing

  • I have tested these changes locally
  • I have added/updated tests as needed
  • All tests pass (npm test)

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have updated docs/ (AGENTS.md) if I made architectural changes

Additional Notes

The new guide follows the progressive disclosure pattern already established in the docs directory — short directives plus pointers to where full details live — and stays within the ~500-line skill body budget it itself recommends.


🤖 Generated by Claude | 2026-02-23 00:00 UTC

@github-actions
Copy link
Contributor

github-actions bot commented Feb 22, 2026

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/cli@0.0.33-pr.286.ddceb19

Prefer not to change any import paths? Install using npm alias so your code still imports base44:

npm i "base44@npm:@base44-preview/cli@0.0.33-pr.286.ddceb19"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "base44": "npm:@base44-preview/cli@0.0.33-pr.286.ddceb19"
  }
}

Preview published to npm registry — try new features instantly!

Consolidates guidance for writing skills, CLAUDE.md, AGENTS.md, and subagent
definitions into a docs topic guide with progressive disclosure patterns.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Paveltarno Paveltarno force-pushed the docs/authoring-agent-instructions branch from 9125c24 to 9231293 Compare February 23, 2026 08:18
@Paveltarno Paveltarno merged commit 541b6ce into main Feb 23, 2026
7 checks passed
@Paveltarno Paveltarno deleted the docs/authoring-agent-instructions branch February 23, 2026 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant