github/sim
1
0
Fork 0
mirror of https://github.com/simstudioai/sim.git synced 2026-01-09 06:58:07 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat(turbo): restructured repo to be a standard turborepo monorepo (#341)

Browse Source 
* added turborepo

* finished turbo migration

* updated gitignore

* use dotenv & run format

* fixed error in docs

* remove standalone deployment in prod

* fix ts error, remove ignore ts errors during build

* added formatter to the end of the docs generator
This commit is contained in:
Waleed Latif
2025-05-09 21:45:49 -07:00
committed by GitHub
parent 1438028982
commit a92ee8bf46
1072 changed files with 39956 additions and 22581 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
scripts/README.md
View File

@@ -11,7 +11,7 @@ This directory contains scripts to automatically generate documentation for all
The documentation generator:
1. Scans the `sim/blocks/blocks/` directory for all block definition files
1. Scans the `apps/sim/blocks/blocks/` directory for all block definition files
2. Extracts metadata from each block including:
- Name, description, and category
- Input and output specifications
@@ -37,6 +37,7 @@ If you encounter TypeScript errors when running the documentation generator, run
```
This will:
1. Install TypeScript, ts-node, and necessary type definitions
2. Create a proper tsconfig.json for the scripts directory
3. Configure the scripts directory to use ES modules
@@ -53,7 +54,7 @@ The documentation generator runs automatically as part of the CI/CD pipeline whe
## Adding Support for New Block Properties
If you add new properties to block definitions that should be included in the documentation, update the `generateMarkdownForBlock` function in `scripts/generate-block-docs.ts`.
If you add new properties to block definitions that should be included in the documentation, update the `generateMarkdownForBlock` function in `scripts/generate-block-docs.ts`.
## Preserving Manual Content
@@ -70,9 +71,9 @@ The documentation generator now supports preserving manually added content when
To add custom content to any tool's documentation, insert MDX comment blocks with section markers:
```markdown
{/* MANUAL-CONTENT-START:sectionName */}
{/_ MANUAL-CONTENT-START:sectionName _/}
Your custom content here (Markdown formatting supported)
{/* MANUAL-CONTENT-END */}
{/_ MANUAL-CONTENT-END _/}
```
Replace `sectionName` with one of the supported section names:
@@ -87,8 +88,9 @@ Replace `sectionName` with one of the supported section names:
To add custom examples to a tool doc:
```markdown
{/* MANUAL-CONTENT-START:usage */}
````markdown
{/_ MANUAL-CONTENT-START:usage _/}
## Examples
### Basic Usage
@@ -99,11 +101,14 @@ To add custom examples to a tool doc:
"anotherParameter": "anotherValue"
}
```
````
### Advanced Configuration
Here's how to use this tool for a specific use case...
{/* MANUAL-CONTENT-END */}
{/_ MANUAL-CONTENT-END _/}
```
When the documentation is regenerated, your manual content will be preserved in the appropriate section automatically. The script will not add any placeholders or markers to files by default.
When the documentation is regenerated, your manual content will be preserved in the appropriate section automatically. The script will not add any placeholders or markers to files by default.
```

837
scripts/generate-block-docs.ts
View File

File diff suppressed because it is too large Load Diff

8
scripts/generate-docs.sh
View File

@@ -57,4 +57,10 @@ if ! npx tsx ./generate-block-docs.ts; then
fi
echo "Documentation generation complete!"
echo "Generated documentation can be found in docs/content/docs/tools/"
echo "Generated documentation can be found in apps/docs/content/docs/tools/"
# Run prettier on the generated documentation files
echo "Formatting generated documentation files with Prettier..."
cd "$ROOT_DIR"
npx prettier --write "apps/docs/content/docs/tools/**/*.mdx"
echo "Formatting complete!"

32
scripts/package-lock.json generated
View File

@@ -8,11 +8,11 @@
"name": "sim-doc-generator",
"version": "1.0.0",
"devDependencies": {
"@types/node": "^22.14.1",
"@types/react": "^19.1.2",
"glob": "^11.0.1",
"@types/node": "^22.15.17",
"@types/react": "^19.1.3",
"glob": "^11.0.2",
"ts-node": "^10.9.2",
"tsx": "^4.19.3",
"tsx": "^4.19.4",
"typescript": "^5.8.3"
}
},
@@ -529,9 +529,9 @@
"license": "MIT"
},
"node_modules/@types/node": {
"version": "22.14.1",
"resolved": "https://registry.npmjs.org/@types/node/-/node-22.14.1.tgz",
"integrity": "sha512-u0HuPQwe/dHrItgHHpmw3N2fYCR6x4ivMNbPHRkBVP4CvN+kiRrKHWk3i8tXiO/joPwXLMYvF9TTF0eqgHIuOw==",
"version": "22.15.17",
"resolved": "https://registry.npmjs.org/@types/node/-/node-22.15.17.tgz",
"integrity": "sha512-wIX2aSZL5FE+MR0JlvF87BNVrtFWf6AE6rxSE9X7OwnVvoyCQjpzSRJ+M87se/4QCkCiebQAqrJ0y6fwIyi7nw==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -539,9 +539,9 @@
}
},
"node_modules/@types/react": {
"version": "19.1.2",
"resolved": "https://registry.npmjs.org/@types/react/-/react-19.1.2.tgz",
"integrity": "sha512-oxLPMytKchWGbnQM9O7D67uPa9paTNxO7jVoNMXgkkErULBPhPARCfkKL9ytcIJJRGjbsVwW4ugJzyFFvm/Tiw==",
"version": "19.1.3",
"resolved": "https://registry.npmjs.org/@types/react/-/react-19.1.3.tgz",
"integrity": "sha512-dLWQ+Z0CkIvK1J8+wrDPwGxEYFA4RAyHoZPxHVGspYmFVnwGSNT24cGIhFJrtfRnWVuW8X7NO52gCXmhkVUWGQ==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -784,9 +784,9 @@
}
},
"node_modules/glob": {
"version": "11.0.1",
"resolved": "https://registry.npmjs.org/glob/-/glob-11.0.1.tgz",
"integrity": "sha512-zrQDm8XPnYEKawJScsnM0QzobJxlT/kHOOlRTio8IH/GrmxRE5fjllkzdaHclIuNjUQTJYH2xHNIGfdpJkDJUw==",
"version": "11.0.2",
"resolved": "https://registry.npmjs.org/glob/-/glob-11.0.2.tgz",
"integrity": "sha512-YT7U7Vye+t5fZ/QMkBFrTJ7ZQxInIUjwyAjVj84CYXqgBdv30MFUPGnBR6sQaVq6Is15wYJUsnzTuWaGRBhBAQ==",
"dev": true,
"license": "ISC",
"dependencies": {
@@ -1112,9 +1112,9 @@
}
},
"node_modules/tsx": {
"version": "4.19.3",
"resolved": "https://registry.npmjs.org/tsx/-/tsx-4.19.3.tgz",
"integrity": "sha512-4H8vUNGNjQ4V2EOoGw005+c+dGuPSnhpPBPHBtsZdGZBk/iJb4kguGlPWaZTZ3q5nMtFOEsY0nRDlh9PJyd6SQ==",
"version": "4.19.4",
"resolved": "https://registry.npmjs.org/tsx/-/tsx-4.19.4.tgz",
"integrity": "sha512-gK5GVzDkJK1SI1zwHf32Mqxf2tSJkNx+eYcNly5+nHvWqXUJYUkWBQtKauoESz3ymezAI++ZwT855x5p5eop+Q==",
"dev": true,
"license": "MIT",
"dependencies": {

8
scripts/package.json
View File

@@ -5,11 +5,11 @@
"type": "module",
"private": true,
"devDependencies": {
"@types/node": "^22.14.1",
"@types/react": "^19.1.2",
"glob": "^11.0.1",
"@types/node": "^22.15.17",
"@types/react": "^19.1.3",
"glob": "^11.0.2",
"ts-node": "^10.9.2",
"tsx": "^4.19.3",
"tsx": "^4.19.4",
"typescript": "^5.8.3"
}
}