Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 1.29 KB

README.md

File metadata and controls

45 lines (26 loc) · 1.29 KB
Raw

.ai

This folder contains AI-assisted development tools for improving code quality and consistency.

How to use?

  • Click on the "Use this template" button
  • Create a .ai folder in your repository
  • Move the content of this template into the .ai folder

Codex

Files

  • codex.md: AI Codex - A repository of learnings and errors.
  • learn.md: AI Learn - Protocol for updating the AI Codex.

Usage

  1. Review the Codex: @codex.md (silent load, no output)
  2. Update the Codex: @learn.md

Important Note

@codex.md should be added to the context of every chat:

  • For regular chats: Use the plus button at the top of the chat to add the file.
  • For Composers: Add the file to a Project Composer so all Composers created in that project will automatically have the file.

Structure

The Codex (codex.md) is divided into two main sections:

  1. Errors: Mistakes made and how to prevent them.
  2. Learnings: Insights gained and their applications.

Each entry includes context, description, correction/application, and related entries.

Contributing

This is an open-source template. Contributions are welcome! Please add a changelog entry with your contribution.

Note

This system is designed for AI consumption. Entries should prioritize precision and relevance over human readability.