📁 Project Structure

When you run Code-y, it generates a `documentation` directory within your project (or in a custom output path if specified). Understanding this structure can be helpful.

Generated `documentation` Directory

Here's a typical layout of the `documentation` folder:

your-project/
├── documentation/           # Generated documentation root
│   ├── docs-data/          # Core JSON data files for the UI
│   │   ├── component-index.json # Index of all components
│   │   ├── function-index.json  # Index of all functions
│   │   ├── class-index.json     # Index of all classes
│   │   ├── [entity-slug].json   # Detailed data for each specific entity
│   │   └── config.json          # Configuration used for this generation
│   ├── vector-db/          # Local FAISS vector embeddings (if AI enabled)
│   │   └── faiss_index          # The actual vector store
│   ├── ui-assets/            # Static assets for the web UI (if built separately)
│   └── ...                   # Other files related to the UI build
├── codey.config.js         # Your project's Code-y configuration (optional)
├── langflow-config.json    # AI workflow configuration (optional, experimental)
└── docs-url.txt            # A simple text file containing the URL to the running docs UI

Key Components:

• `docs-data/`: This is the heart of your generated documentation. It contains JSON files that the Code-y web interface uses to render all the information.
  • component-index.json, function-index.json, etc.: These are manifest files listing all discovered entities of a certain type.
  • [entity-slug].json: For each component, function, or class, a detailed JSON file is created (e.g., `button-component.json`). This file contains its parsed information, relationships, AI-generated descriptions, and more.
  • config.json: Stores a snapshot of the Code-y configuration that was used for this particular documentation build.
• `vector-db/`: If you have AI features enabled (specifically semantic search or AI chat that uses embeddings), this directory will contain the local FAISS vector database. This database stores the numerical representations (embeddings) of your code snippets.
• `ui-assets/` (Potentially): If you use the `code-y build` command to create a static version of the documentation UI, this folder (or a similar one like `_next` if it's a Next.js build) would contain the necessary HTML, CSS, and JavaScript files for the standalone site. When using `code-y generate` or `code-y serve-ui`, these assets are typically served dynamically.
• `docs-url.txt`: For convenience, Code-y creates this small text file at the root of your project (or next to the `documentation` folder if output is customized). It simply contains the URL (e.g., `http://localhost:3000`) where the documentation UI is being served, making it easy to find.

Your Configuration Files:

• `codey.config.js`: If you create this file in your project root, Code-y will use it for configuration. This is the recommended way to manage settings for a project.
• `langflow-config.json` (Experimental): If you are using custom AI workflows with LangFlow, this file would define that pipeline.

Generally, you don't need to manually edit files within the `documentation` directory, as Code-y manages them. However, understanding the structure can be useful for troubleshooting or if you have advanced use cases.