What Is the Purpose of the docs Directory in i-have-adhd?

The i-have-adhd repository does not contain a top-level docs directory; instead, it distributes documentation across specialized Markdown files located in the project root, the /.github directory, and skill-specific subfolders to maintain tight coupling between code and technical reference.

The ayghri/i-have-adhd project deliberately avoids the conventional docs folder structure common in open-source repositories. By embedding documentation directly within the repository root and specialized subdirectories, the project ensures that setup instructions, contribution guidelines, and behavioral specifications remain immediately discoverable and contextually linked to the source code they describe.

Documentation Files in the Project Root

Rather than nesting guides within a separate folder, i-have-adhd places critical documentation files at the repository root for immediate visibility:

• README.md — Contains the project overview, quick-start instructions, and high-level concepts that introduce users to the repository's purpose.
• INSTALL.md — Provides platform-specific setup steps and dependency requirements for running the project locally.
• CONTRIBUTING.md — Defines the coding standards, review workflow, and procedures for proposing changes to the codebase.
• AGENTS.md — Maps runtime adapters, entry-point locations, and plugin metadata essential for understanding the project's execution model.

Specialized Documentation Locations

Beyond the root files, the repository organizes domain-specific reference material in dedicated functional directories.

Skill Definitions in skills/i-have-adhd/

The canonical behavioral rules for the "i-have-adhd" skill reside at skills/i-have-adhd/SKILL.md. This file defines the specific parameters, capabilities, and constraints of the ADHD skill implementation, serving as the authoritative specification for how the feature operates within the broader system.

Localized Content in .github/readme/

Internationalization support lives within the /.github/readme/ subdirectory, which houses translated versions of the main README (such as README.vi.md for Vietnamese). This location choice separates localization assets from core code while keeping them within the .github ecosystem typically reserved for repository metadata and community health files.

Programmatic Documentation Access

The repository references these Markdown files directly at runtime rather than treating documentation as static assets separate from the executable code:

// Example: loading the skill definition at runtime
import skill from "./skills/i-have-adhd/SKILL.md";
console.log("Skill rules loaded:", skill);

// Example: plugin manifest referencing the README for description
{
  "name": "i-have-adhd",
  "description": "See https://github.com/ayghri/i-have-adhd/blob/main/README.md for details."
}

These patterns demonstrate that the codebase treats documentation as importable modules and linked resources, justifying the flat file structure over a separate docs hierarchy.

Summary

• No docs directory exists: The i-have-adhd repository deliberately omits a conventional documentation folder.
• Root-level organization: Core guides (README.md, INSTALL.md, CONTRIBUTING.md, AGENTS.md) live in the project root for immediate access.
• Functional distribution: Skill specifications reside in skills/i-have-adhd/SKILL.md, while translations live in .github/readme/.
• Code coupling: Documentation files are programmatically referenced by the application code, creating tight integration between instructions and implementation.

Frequently Asked Questions

Does i-have-adhd have official documentation?

Yes. While the repository lacks a traditional docs directory, it provides comprehensive documentation through specialized Markdown files located in the project root (README.md, INSTALL.md, CONTRIBUTING.md, AGENTS.md) and within functional subdirectories like skills/i-have-adhd/ and .github/readme/.

Where is the installation guide located in i-have-adhd?

The installation instructions reside in INSTALL.md at the repository root. This file contains platform-specific setup steps and dependency information required to configure the development environment.

How does i-have-adhd handle multilingual documentation?

Localized versions of the README are stored in the .github/readme/ directory (for example, README.vi.md for Vietnamese translations). This approach leverages the .github folder's standard purpose for repository metadata while keeping language variants organized and discoverable.

Why doesn't i-have-adhd use a docs directory?

The repository employs a flat documentation structure to keep technical reference closely coupled with the source code it describes. According to the ayghri/i-have-adhd source code, this design simplifies navigation by placing critical files at the root and allows the application to import Markdown files directly as runtime configuration resources.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}