Skip to content

Commit

Permalink
Update README.md to include comprehensive examples for user intent pr…
Browse files Browse the repository at this point in the history
…ocessing and execution steps
  • Loading branch information
TheWhiteWord committed Dec 23, 2024
1 parent ced625f commit d932295
Showing 1 changed file with 74 additions and 2 deletions.
76 changes: 74 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,18 +76,61 @@ The LLM:
- description: "Entry point for processing user requests"
- state_transfer: ["user_intent", "system_context"]
- condition: "llm.shouldActivate(context)"
- next_warmhole: "llm.decideNextWarmhole(context)"
- llm_context: {
purpose: "Process and understand user intent",
capabilities: ["intent analysis", "path planning", "context management"]
}
```

## Comprehensive Example

### User Intent Processing
```markdown
# Function: analyze_data
- description: "Analyze the provided dataset and generate a report"
- input: dataset: string
- output: report: object
- template: data_analyzer
- llm_context: true
```

### Data Analyzer Template
```markdown
# Template: data_analyzer
- input_placeholder: "{{dataset}}"
- transform: |
const analysis = analyzeDataset(context.dataset);
return generateReport(analysis);
- output_format: object
- requires_llm: true
```

### Warmhole Definitions
```markdown
# Warmhole: data_processing
- description: "Process the dataset and prepare for analysis"
- state_transfer: ["dataset", "analysis_ready"]
- condition: "llm.shouldProcessData(context)"
- llm_context: {
purpose: "Prepare dataset for analysis",
capabilities: ["data cleaning", "data transformation"]
}

# Warmhole: report_generation
- description: "Generate a report from the analyzed data"
- state_transfer: ["analysis_report", "final_report"]
- condition: "llm.shouldGenerateReport(context)"
- llm_context: {
purpose: "Generate comprehensive report",
capabilities: ["report generation", "data visualization"]
}
```

## Quick Start

1. Send a request to the system:
```javascript
const result = await system.process("Process this dataset and generate a report");
const result = await system.process("Analyze this dataset and generate a report");
```

The LLM will:
Expand All @@ -97,6 +140,35 @@ The LLM will:
4. Execute required functions
5. Return results and documentation

## Example Usage

### Step-by-Step Execution
1. **Initialize the System**:
```javascript
const readmeContent = loadReadmeContent();
const initResult = system_init(readmeContent);
console.log('System initialization result:', initResult);
```

2. **Process User Intent**:
```javascript
const userIntent = "Analyze this dataset and generate a report";
const executionPlan = await processUserIntent(userIntent, systemState);
console.log('Execution Plan:', executionPlan);
```

3. **Execute the Plan**:
```javascript
const executionResult = await execute(executionPlan);
console.log('Execution Result:', executionResult);
```

## Conclusion

The READMEs Programming System leverages LLM-driven navigation and execution to transform README.md files into executable documentation. By following the comprehensive example provided, users can harness the full capabilities of the system to automate complex workflows and achieve seamless integration between documentation and execution.

For more details, refer to the [Documentation Standards](doc/Rdm_standards.md) and [Parser Rules](doc/Rmd_parser_rules.md).

---
📝 LLM-Driven README Programming System
🤖 Autonomous Navigation & Execution

0 comments on commit d932295

Please sign in to comment.