Installation and Setup
Relevant source files
The following files were used as context for generating this wiki page:
Installation and Setup within the devmarketing-skills repository refers to the deployment of Agent Skills into a standardized environment and the subsequent initialization of a foundational "Developer Audience Context." This process ensures that AI agents have the necessary domain knowledge and architectural constraints to generate effective developer-facing content, such as tutorials, documentation, and marketing strategies.
The system follows the Agent Skills specification, which mandates a content-only, directory-based installation. This setup is crucial for maintaining a "Source of Truth" regarding the target developer persona, tech stack, and pain points before any technical content is produced.
Skill Framework Deployment
Skills in this repository are installed into a cross-agent standard directory: .agents/skills/. These skills are content-only and do not require a traditional build step, though they must adhere to specific YAML frontmatter constraints for discovery and metadata processing.
Directory Structure Requirements
A valid skill installation must follow a specific hierarchy within the skills/ directory. Each skill is contained within its own subdirectory, matching the name field in the SKILL.md frontmatter.
| Component | Path | Description |
|---|---|---|
| Core Instructions | SKILL.md | Required. Main instructions, must be < 500 lines. |
| Overview | README.md | Recommended. Quick usage and overview. |
| Supporting Docs | references/ | Optional. Detailed templates and examples. |
| Executable Code | scripts/ | Optional. Code for automated tasks. |
Sources: AGENTS.md:7-12, AGENTS.md:54-61
Skill Naming and Metadata Validation
When setting up or creating new skills, the following validation rules must be met:
- Name: 1-64 characters, lowercase alphanumeric and hyphens only.
- Description: 1-1024 characters, including trigger phrases for discovery.
- YAML Frontmatter: Must be valid and contain at least the
nameanddescriptionfields.
Sources: AGENTS.md:29-33, AGENTS.md:46-52
Foundational Context Initialization
The most critical step in the setup process is the establishment of the developer-audience-context. All other skills depend on this context to understand who they are writing for and what technical constraints apply.
The .agents/developer-audience-context.md File
Before any other skill is utilized, the environment must check for the existence of .agents/developer-audience-context.md. If it does not exist, it must be created through either an automated draft from the existing codebase (analyzing README.md, package.json, etc.) or a manual walkthrough of the 10 core sections.
This diagram illustrates the initialization flow for setting up the foundational context:
The flow ensures that every marketing action is grounded in verified developer personas and technical requirements.
Sources: skills/developer-audience-context/SKILL.md:14-36, AGENTS.md:74-81
Development Environment Setup Patterns
For technical tutorials and onboarding, the setup phase must be explicit and foolproof. This involves defining prerequisites and providing verification commands to ensure the developer's environment is ready for the "Time-to-First-Value" moment.
Prerequisite Definition
Setup guides must include a table of requirements with specific versions and check commands.
| Requirement | Version | Check Command |
|---|---|---|
| Node.js | 18+ | node --version |
| npm | 9+ | npm --version |
| Git | Any | git --version |
Sources: skills/technical-tutorials/SKILL.md:74-85
Implementation of "It Works!" Checkpoints
To ensure successful installation, the setup logic incorporates checkpoints every 3-5 steps. These are designed to provide visual or terminal-based confirmation that the environment is configured correctly.
This sequence demonstrates the progressive verification used in the project's onboarding and tutorial frameworks.
Sources: skills/technical-tutorials/SKILL.md:162-185, skills/developer-onboarding/SKILL.md:46-55
Repository and Documentation Optimization
Setup also involves configuring the project's GitHub presence to maximize discoverability and ease of use for contributors.
GitHub Repository Metadata
| Element | Best Practice |
|---|---|
| Description | 100 characters max, keyword-rich. |
| Topics | 5-20 relevant tags (e.g., javascript, cli, api). |
| README | Must include a "Quick Start" that works in < 2 minutes. |
| Issue Templates | Standardized formats for Bug Reports and Feature Requests. |
Sources: skills/open-source-marketing/SKILL.md:74-85, skills/github-presence/SKILL.md:139-145
Quickstart Configuration
The docs-as-marketing skill defines a strict hierarchy for the "Installation" section of documentation. It must follow the "5-Minute Rule," ensuring developers reach a meaningful success moment (TTFV) within 300 seconds of beginning the setup.
## Step 1: Install
[Single command, copy-paste ready]
## Step 2: Configure
[Minimal configuration, explain what each part does]
## Step 3: Run
[The payoff—show them it works]
Sources: skills/docs-as-marketing/SKILL.md:83-95, skills/developer-onboarding/SKILL.md:65-80
Conclusion
Installation and Setup in this project is a dual-layered process that transitions from deploying the Agent Skill framework (as defined in AGENTS.md) to establishing a deep, persistent developer-audience-context. By standardizing these setup patterns, the project ensures that all subsequent developer engagement—whether through tutorials, SDKs, or documentation—is technically accurate, easy to verify via checkpoints, and optimized for rapid developer activation.