Getting Started

Welcome to agentic_programs! This guide will help you get up and running.

Prerequisites

• Python 3.8 or higher
• pip (Python package installer)
• Git
• Java (for PlantUML diagram rendering)

Installation

1. Clone the repository (if not already done):

   git clone https://github.com/ovesorg/agentic_programs.git
   cd agentic_programs
   

2. Install Python dependencies:

   pip install -r requirements.txt
   

Quick Start

Start the Development Server

mkdocs serve

Open your browser to http://127.0.0.1:8000

Build the Site

mkdocs build

The static site will be generated in the site/ directory.

Next Steps

• 📝 Edit content in the docs/ folder
• 📊 Add PlantUML diagrams to docs/diagrams/plantuml/
• 🎨 Customize styles in docs/stylesheets/extra.css
• ⚙️ Configure navigation in mkdocs.yml

Working with Diagrams

To render PlantUML diagrams:

python scripts/render_plantuml.py

Place .puml files in docs/diagrams/plantuml/ and they'll be rendered to PNG in docs/diagrams/images/.