1.8 KiB
AGENTS.md
This file provides guidance to code assistants like Claude Code (claude.ai/code), Gemini CLI (geminicli.com) or OpenAI Codex (openai.com/codex) when working with code in this repository.
Project Overview
This repository contains the code for a project called KnowFoolery. Project overview file: @README.md
Documentation Structure
Requirements
The docs/1_requirements/ directory contains functional and non-functional specifications:
@docs/1_requirements/functional-requirements.md - Functional requirements for KnowFoolery
@docs/1_requirements/non-functional-requirements.md - Non functional requirements for KnowFoolery
Architecture
The docs/2_architecture/ directory contains technical, security, and observability architectures:
@docs/2_architecture/application-architecture.md - Application Architecture for KnowFoolery
@docs/2_architecture/observability-architecture.md - Observability Architecture for KnowFoolery
@docs/2_architecture/security-architecture.md - Security Architecture for KnowFoolery
Design and Development guidelines
The docs/3_guidelines/ directory contains guidelines for design, development, authentication, security, and observability:
@docs/3_guidelines/design-guidelines.md - Design guidelines for KnowFoolery
@docs/3_guidelines/development-guidelines.md - Development guidelines for KnowFoolery
@docs/3_guidelines/observability-guidelines.md - Observability guidelines for KnowFoolery
@docs/3_guidelines/security-guidelines.md - Security guidelines for KnowFoolery
@docs/3_guidelines/zitadel-guidelines.md - Zitadel integration guidelines for KnowFoolery
Work plan
The docs/4_work_plan/ directory contains the work plan for knowfoolery implementatio:
@docs/4_work_plan/overall-plan.md - High-level implementation plan for knowfoolery
Work instructions
Never read nor use files in .junk directory