📌 Project Requires Proper Documentation

[nathanieluriri]

@nathanieluriri

📌 Issue: Project Requires Proper Documentation

📝 Overview

The project is currently lacking clear and centralized documentation, which is essential for both onboarding new contributors and ensuring consistent usage of the CLI tools and project structure.

Proper documentation will serve as the single source of truth for how to use, extend, and contribute to the project.

---

📚 Documentation Should Cover:

• Getting Started

  • Prerequisites
  • Installation
  • First command: creating a project/app

• CLI Commands

  • make project
  • make app
  • make-schema, make-crud, make-route
  • How to use the plan file

• Plan File Format

  • Syntax and structure
  • Examples
  • Best practices

• Project Architecture

  • Folder structure
  • How generated code is organized

• Extending the Tooling

  • Creating custom generators
  • Plugin support (if planned)

• Contribution Guidelines

  • How to contribute to the codebase
  • Issue and PR process
  • Coding standards

---

✅ Benefits

• Improves onboarding for new developers
• Reduces time spent answering recurring questions
• Boosts adoption and usability of the tooling
• Makes the project more maintainable and scalable

---

📌 Next Steps

• Decide on the format (e.g., docs/, README-based, or hosted site)
• Assign ownership or split documentation into tasks
• Create templates or documentation standards

---