Skip to content

Commit 97aa783

Browse files
committed
Add comprehensive documentation overview for Ray.InputQuery
1 parent c35ae52 commit 97aa783

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Documentation Overview
2+
3+
This directory contains comprehensive documentation for Ray.InputQuery.
4+
5+
## Directory Structure
6+
7+
### prompts/
8+
Contains AI prompts for automatic generation and development assistance:
9+
- **input-class-generator.md** - Prompt for generating Input classes from forms or parameter lists
10+
- **usage-generator.md** - Prompt for generating usage examples and integration patterns
11+
- **README.md** - Usage guide for the prompt files
12+
13+
These prompts help developers leverage AI to accelerate Ray.InputQuery adoption and implementation.
14+
15+
### design/
16+
Contains design philosophy, concepts, and architectural documentation:
17+
- Design principles and philosophy behind Ray.InputQuery
18+
- Input-as-first-class-citizen concept explanations
19+
- Innovation patterns and use case studies
20+
- Framework philosophy and architectural decisions
21+
22+
The design documentation explains the theoretical foundation and rationale behind Ray.InputQuery's approach to input handling.
23+
24+
### sample-data/
25+
Contains various data format examples and patterns for Input class generation:
26+
- Sample data in different formats (HTML forms, JSON schemas, GraphQL schemas, CSV data, OpenAPI specs)
27+
- PHP method signatures and scalar-to-structured transformation patterns
28+
- UI mockups and wireframes examples
29+
- ALPS profiles for API documentation
30+
31+
These samples serve as reference material and test cases for Input class generation and demonstrate real-world data structure patterns.
32+
33+
---
34+
35+
Use these resources to understand, implement, and extend Ray.InputQuery in your projects.

0 commit comments

Comments
 (0)