Documentation Map
This file serves as a central map for all documentation in the Docs/ folder.
Getting Started
- Installation Instructions – Describes requirements (PHP & Composer) and provides installation scripts for Unix and Windows.
- Getting Started – Overview of ForgeFoundary, first steps, and initial setup.
- Creating Modes – Guide for creating custom scaffolding modes.
- Commands Reference – Overview of available commands and their purposes.
Commands Documentation
- Scaffold Command – Main scaffolding command to generate project structure.
- Create Mode Command – Command to create a new mode scaffold.
- Dry Run Command – Simulate scaffolding without changing real files.
- Dumb Mode Command – Dump configuration values for a single mode.
- Dumb Modes Command – List all available modes and their metadata.
Mode Sections
Each mode in ForgeFoundary can include optional and required sections to define its behavior. These sections are documented individually:
- Mode Metadata – Basic metadata for a mode (name, version, author, description, language).
- Mutators – Define reusable anchors for values and link them to CLI flags.
- CLI Flags – Optional feature to modify values via terminal using mutators.
- Component – Core section defining the component path and name. Required.
- Directories – Optional folder structure definitions.
- Commands – Optional pre/post scaffolding commands.
- Templates – Optional templates section with defaults, overrides, and supported engines.
- Units – Optional units system for advanced scaffolding logic.
- Naming Conventions – Optional section to enforce naming styles and apply exceptions.
- Enabling or Disabling Sections – Control which sections are processed during scaffolding.
This map will continue to grow as more documentation is added, providing a single reference point for all ForgeFoundary features.