docs

Summarize arccjs architecture and conventions from the docs folder.

2|2|Updated Nov 11, 2023
One-click install
npx skills add https://github.com/temptemp3/arccjs --skill docs-temptemp3
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/temptemp3/arccjs/tree/main/docs
Command: npx skills add https://github.com/temptemp3/arccjs --skill docs-temptemp3

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This document provides a canonical reference and conventions guide for AI coding agents working with the arccjs codebase, ensuring consistent understanding of architecture, layout, and integration patterns.

Core Features & Use Cases

  • Authoritative architecture overview: documents the project structure (src, docs, dist) and the role of SKILL.md in agent discovery.
  • Conventions and discovery flow: explains ASDF-based metadata discovery, dynamic method binding, and ARC-2 note prefixes.
  • Onboarding and tooling: serves as a guide for new contributors and AI agents to navigate the repository and align tooling with arccjs conventions.
  • Use Case: reference how to locate contract and composer documentation to implement AI-assisted code exploration.

Quick Start

Open the SKILL.md in this folder and review the accompanying docs to understand arccjs architecture and conventions.

Frequently Asked Questions about docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What is ASDF-based discovery for AI coding agents?

ASDF-based discovery is a frontmatter-driven approach that helps AI agents locate and understand project conventions. It uses metadata in SKILL.md files to guide agents through the arccjs codebase structure and architectural rules.

How do I navigate arccjs architecture and conventions as a new contributor?

To navigate arccjs architecture, open the SKILL.md file and review the docs folder. This provides a canonical reference for the project structure, dynamic method binding, and ARC-2 note prefixes used throughout the codebase.

Where can I find documentation on CONTRACT and AtomicComposer for arccjs?

Documentation for CONTRACT and AtomicComposer is located within the arccjs docs folder. These references explain how to implement AI-assisted code exploration and understand the utility integrations available in the project.

Does the arccjs project structure support standard src, docs, and dist directories?

Yes, the arccjs project structure supports standard src, docs, and dist directories. The architecture overview documents how these directories are organized and how agents should interact with them during code exploration.

What are ARC-2 note prefixes and when do I need them in arccjs?

ARC-2 note prefixes are a convention used in arccjs to standardize documentation and communication within the codebase. You need them when contributing code or documentation to ensure compliance with the project's established architectural patterns.

Why use SKILL.md for AI agent onboarding instead of standard README files?

SKILL.md provides targeted agent discovery metadata that standard README files lack. It streamlines AI agent onboarding by defining specific architectural conventions, dynamic method binding rules, and navigation paths for the arccjs codebase.