How to add documentation and comments to your ForSure files.
Use the # symbol to add single-line comments.
# This is a comment explaining the structure
root:
- Type: Directory
- Name: src/ # Main source directory
<description>
Source code files
</description>Use <description> tags to add detailed documentation to files and directories.
root:
- Type: File
- Name: README.md
<description>
This is the main README file for the project.
It contains important information about setup,
usage, and contribution guidelines.
</description>
<content>
# Project Name
## Description
A brief description of what this project does.
## Installation
```bash
npm install
```
</content>Comments can be placed anywhere to clarify complex structures.
# Configuration section
config:
- Type: File
- Name: .env.example
<description>
Environment variables template
Copy this to .env and fill in your values
</description>
<content>
# Database configuration
DATABASE_URL=postgresql://user:pass@localhost/db
API_KEY=your-api-key-here
DEBUG=true
</content>
# Source code structure
src:
- Type: Directory
- Name: components/ # UI components
- Name: utils/ # Utility functions
- Name: hooks/ # Custom React hooks