Spaces:
Paused
Paused
Create schema.md
Browse files
schema.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Supported Format Schemas
|
| 2 |
+
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
## 1. Repo2Markdown Format
|
| 6 |
+
**Detection:** Contains \`## File Structure\` AND \`### File:\`.
|
| 7 |
+
**Purpose:** Representing project codebases.
|
| 8 |
+
**Layout Example:**
|
| 9 |
+
# Project Export
|
| 10 |
+
## File Structure
|
| 11 |
+
- main.py
|
| 12 |
+
- utils.py
|
| 13 |
+
|
| 14 |
+
### File: main.py
|
| 15 |
+
```python
|
| 16 |
+
print("Hello World")
|
| 17 |
+
```
|
| 18 |
+
|
| 19 |
+
---
|
| 20 |
+
|
| 21 |
+
## 2. Standard README Format
|
| 22 |
+
**Detection:** Starts with \`#\` and contains at least one \`##\`.
|
| 23 |
+
**Purpose:** Parsing typical project documentation.
|
| 24 |
+
**Layout Example:**
|
| 25 |
+
# Project Title
|
| 26 |
+
Intro text here.
|
| 27 |
+
|
| 28 |
+
## Installation
|
| 29 |
+
Step 1...
|
| 30 |
+
|
| 31 |
+
## Usage
|
| 32 |
+
Run the app...
|
| 33 |
+
|
| 34 |
+
---
|
| 35 |
+
|
| 36 |
+
## 3. Changelog Format
|
| 37 |
+
**Detection:** Version headings like \`## [1.0.0]\`.
|
| 38 |
+
**Purpose:** Version tracking and release notes.
|
| 39 |
+
**Layout Example:**
|
| 40 |
+
# Changelog
|
| 41 |
+
## [1.1.0] - 2023-10-01
|
| 42 |
+
- Added feature X.
|
| 43 |
+
|
| 44 |
+
## [1.0.0] - 2023-09-01
|
| 45 |
+
- Initial release.
|
| 46 |
+
|
| 47 |
+
---
|
| 48 |
+
|
| 49 |
+
## 4. Agent Action Format
|
| 50 |
+
**Detection:** Contains \`### HF_ACTION:\` or "File and Code Formatting:".
|
| 51 |
+
**Purpose:** Automating Hugging Face Space setup.
|
| 52 |
+
**Layout Example:**
|
| 53 |
+
**File and Code Formatting:**
|
| 54 |
+
General instructions for the agent go here.
|
| 55 |
+
|
| 56 |
+
### HF_ACTION: INSTALL requirements.txt
|
| 57 |
+
|
| 58 |
+
### File: app.py
|
| 59 |
+
```python
|
| 60 |
+
import flask
|
| 61 |
+
# code here
|
| 62 |
+
```
|
| 63 |
+
|
| 64 |
+
## File Structure
|
| 65 |
+
```
|
| 66 |
+
.
|
| 67 |
+
└── app.py
|
| 68 |
+
```
|
| 69 |
+
|
| 70 |
+
---
|
| 71 |
+
|
| 72 |
+
## 5. Recipe/Guide Format (Logical Addition)
|
| 73 |
+
**Detection:** Contains \`## Ingredients\` and \`## Instructions\`.
|
| 74 |
+
**Purpose:** Parsing structured "How-To" guides.
|
| 75 |
+
**Layout Example:**
|
| 76 |
+
# Chocolate Cake
|
| 77 |
+
## Ingredients
|
| 78 |
+
- 2 cups Flour
|
| 79 |
+
- 1 cup Cocoa
|
| 80 |
+
|
| 81 |
+
## Instructions
|
| 82 |
+
1. Mix dry ingredients...
|
| 83 |
+
2. Bake at 180°C...
|