Initial commit

docs/guides/getting-started.md

@@ -0,0 +1,104 @@
+# Getting Started with Vuer
+
+**Version:** v0.0.67
+
+## Environment Setup
+
+### Create a Conda Environment
+
+```bash
+conda create -n vuer python=3.8
+conda activate vuer
+```
+
+## Installation
+
+### Latest PyPI Version
+
+Install the latest version with all dependencies:
+
+```bash
+pip install -U 'vuer[all]==0.0.67'
+```
+
+### For Development
+
+If you're contributing to Vuer, use an editable installation:
+
+```bash
+pip install -e '.[all]'
+```
+
+## Key Learning Pathways
+
+### 1. Vuer Basics Tutorial
+Learn foundational concepts for building 3D visualizations with Vuer.
+
+### 2. Tutorial for Roboticists
+Specialized tutorial for robotics applications, including URDF loading and robot visualization.
+
+### 3. Example Gallery
+Extensive collection of examples demonstrating various capabilities.
+
+## VR/AR Headset Access
+
+To access Vuer visualizations on VR/AR headsets:
+
+1. **Install ngrok** to convert local WebSocket connections to secure connections
+2. Local WebSocket: `ws://localhost:8012`
+3. Secure WebSocket via ngrok: `wss://xxxxx.ngrok.io`
+4. Access the visualization through a query parameter
+
+## Running Examples
+
+### Clone and Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/vuer-ai/vuer.git
+cd vuer
+
+# Install with example dependencies
+pip install -U 'vuer[example]==0.0.67'
+
+# Download 3D assets using git LFS
+git lfs pull
+```
+
+### Execute Examples
+
+Navigate to the examples directory and run Python files:
+
+```bash
+cd docs/examples
+python your_example.py
+```
+
+### Apple Silicon Compatibility
+
+**Important:** Apple Silicon users should install a specific version of open3d:
+
+```bash
+pip install open3d==0.15.1
+```
+
+This is due to compatibility issues with newer versions on Apple Silicon.
+
+## Building Documentation
+
+For contributors working on documentation:
+
+```bash
+make docs
+```
+
+## Next Steps
+
+- Explore the [Vuer Basics Tutorial](../tutorials/basics/)
+- Check out the [Robotics Tutorial](../tutorials/robotics/)
+- Browse the [Example Gallery](../examples/)
+- Read the [API Documentation](../api/)
+
+## Source
+
+Documentation: https://docs.vuer.ai/en/latest/quick_start.html

docs/guides/introduction.md

@@ -0,0 +1,59 @@
+# Vuer: 3D Visualization Toolkit
+
+**Version:** v0.0.67
+
+## What is Vuer?
+
+Vuer is a light-weight visualization toolkit for interacting with dynamic 3D and robotics data. The framework emphasizes accessibility, supporting virtual and augmented reality experiences while remaining mobile-device compatible.
+
+## Key Features
+
+- **Lightweight performance** - Efficient 3D rendering and visualization
+- **VR and AR compatibility** - Works with virtual and augmented reality devices
+- **Community support** - Active community and documentation
+- **Extensible and customizable** - Build custom visualizations and components
+- **MIT open-source license** - Free to use and modify
+
+## Installation
+
+Install the framework via pip:
+
+```bash
+pip install 'vuer[all]==0.0.67'
+```
+
+## Quick Example
+
+Here's a straightforward example demonstrating URDF file loading and browser-based visualization:
+
+```python
+from vuer import Vuer
+
+# Create Vuer app
+app = Vuer()
+
+@app.spawn
+async def main(session):
+    # Your visualization code here
+    pass
+
+app.run()
+```
+
+## Development & Expertise
+
+The project emerged from research at MIT and UCSD, with contributors specializing in robotics, computer vision, and computer graphics fields.
+
+## Available Resources
+
+- **Tutorials** - Learn the basics and advanced topics
+  - Vuer Basics
+  - Tutorial for Roboticists
+  - Camera tutorials
+  - Physics and MuJoCo integration
+- **Example Gallery** - Diverse use cases and demonstrations
+- **API Documentation** - Comprehensive reference for components and data types
+
+## Source
+
+Documentation available at: https://docs.vuer.ai/