mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-10 07:27:57 -05:00
54e1439224
* added scaffolding for auto-generating docs for integrations based on block definition, get rendering error for mdx pages * page renders, have to add more useful information * standardized tool naming convention, added script to autogenerate docs for integrations, added docs for each tool * re-generated docs, updated CONTRIBUTING.md to reflect new format * added a dedicated tools page * added additional information for tools, added manual section logic to docs producer * added a link back to sim studio, fixed z level issue on mobile, added better intro * updated script to more accurately reflect the params for each tool, as well as the overall blocks' output
60 lines
1.5 KiB
Bash
Executable File
60 lines
1.5 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Set error handling
|
|
set -e
|
|
|
|
# Enable debug mode if DEBUG env var is set
|
|
if [ ! -z "$DEBUG" ]; then
|
|
set -x
|
|
echo "Debug mode enabled"
|
|
fi
|
|
|
|
# Get script directories
|
|
SCRIPTS_DIR=$(dirname "$0")
|
|
ROOT_DIR=$(cd "$SCRIPTS_DIR/.." && pwd)
|
|
echo "Scripts directory: $SCRIPTS_DIR"
|
|
echo "Root directory: $ROOT_DIR"
|
|
|
|
# Check if dependencies are installed in scripts directory
|
|
if [ ! -d "$SCRIPTS_DIR/node_modules" ]; then
|
|
echo "Required dependencies not found. Installing now..."
|
|
bash "$SCRIPTS_DIR/setup-doc-generator.sh"
|
|
fi
|
|
|
|
# Generate documentation
|
|
echo "Generating block documentation..."
|
|
|
|
# Check if necessary files exist
|
|
if [ ! -f "$SCRIPTS_DIR/generate-block-docs.ts" ]; then
|
|
echo "Error: Could not find generate-block-docs.ts script"
|
|
ls -la "$SCRIPTS_DIR"
|
|
exit 1
|
|
fi
|
|
|
|
if [ ! -f "$SCRIPTS_DIR/tsconfig.json" ]; then
|
|
echo "Error: Could not find tsconfig.json in scripts directory"
|
|
exit 1
|
|
fi
|
|
|
|
# Check if npx is available
|
|
if ! command -v npx &> /dev/null; then
|
|
echo "Error: npx is not installed. Please install Node.js first."
|
|
exit 1
|
|
fi
|
|
|
|
# Change to scripts directory to use local dependencies
|
|
cd "$SCRIPTS_DIR"
|
|
echo "Executing: npx tsx ./generate-block-docs.ts"
|
|
|
|
# Run the generator with tsx using local dependencies
|
|
if ! npx tsx ./generate-block-docs.ts; then
|
|
echo ""
|
|
echo "Error running documentation generator."
|
|
echo ""
|
|
echo "For more detailed debugging, run with DEBUG=1:"
|
|
echo "DEBUG=1 ./scripts/generate-docs.sh"
|
|
exit 1
|
|
fi
|
|
|
|
echo "Documentation generation complete!"
|
|
echo "Generated documentation can be found in docs/content/docs/tools/" |