Swastika/mint docs/new pages #2071
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| paths: | ||
| - 'docs/**' | ||
| pull_request: | ||
| paths: | ||
| - 'docs/**' | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: {} | ||
|
|
||
| jobs: | ||
| validate: | ||
| timeout-minutes: 5 | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '20' | ||
|
|
||
| - name: Install docs dependencies | ||
| working-directory: docs | ||
| run: npm ci | ||
|
|
||
| - name: Validate Mintlify docs | ||
| working-directory: docs | ||
| run: npm run validate | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| { | ||
|
Contributor
There was a problem hiding this comment. This PR is nice, but I think there are a few things we need in the first PR.
|
||
| "theme": "mint", | ||
| "name": "Dimensional", | ||
| "description": "Official documentation for Dimensional (DimOS) \u2014 the modern operating system for generalist robotics: Python-first, agent-native, and hardware-agnostic.", | ||
|
Contributor
There was a problem hiding this comment. On the readme we call it "The Agentive Operating System for Physical Space" (although I think agentive should be agentic) |
||
| "colors": { | ||
| "primary": "#1682a3", | ||
| "light": "#1682a3", | ||
| "dark": "#1682a3" | ||
| }, | ||
| "favicon": "assets/favicon.png", | ||
| "seo": { | ||
| "metatags": { | ||
| "og:site_name": "Dimensional", | ||
| "apple-mobile-web-app-title": "Dimensional" | ||
| } | ||
| }, | ||
| "navigation": { | ||
| "groups": [ | ||
| { | ||
| "group": "Getting Started", | ||
| "pages": [ | ||
| "introduction", | ||
| "quickstart", | ||
| "requirements", | ||
| { | ||
| "group": "Installation", | ||
| "pages": [ | ||
| "installation/ubuntu", | ||
| "installation/osx", | ||
| "installation/nix" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Usage", | ||
| "pages": [ | ||
| "usage/README", | ||
| "usage/blueprints", | ||
| "usage/modules", | ||
| "usage/native_modules", | ||
| "usage/configuration", | ||
| "usage/cli", | ||
| "usage/python-api", | ||
| "usage/lcm", | ||
| "usage/transforms", | ||
| "usage/tool_streams", | ||
| "usage/visualization", | ||
| { | ||
| "group": "Data Streams", | ||
| "pages": [ | ||
| "usage/data_streams/README", | ||
| "usage/data_streams/reactivex", | ||
| "usage/data_streams/advanced_streams", | ||
| "usage/data_streams/quality_filter", | ||
| "usage/data_streams/temporal_alignment", | ||
| "usage/data_streams/storage_replay" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Sensor Streams", | ||
| "pages": [ | ||
| "usage/sensor_streams/README", | ||
| "usage/sensor_streams/reactivex", | ||
| "usage/sensor_streams/advanced_streams", | ||
| "usage/sensor_streams/quality_filter", | ||
| "usage/sensor_streams/temporal_alignment", | ||
| "usage/sensor_streams/storage_replay" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Transports", | ||
| "pages": [ | ||
| "usage/transports/index", | ||
| "usage/transports/dds" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Capabilities", | ||
| "pages": [ | ||
| "capabilities/agents/readme", | ||
| { | ||
| "group": "Navigation", | ||
| "pages": [ | ||
| "capabilities/navigation/readme", | ||
| "capabilities/navigation/native/index" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Manipulation", | ||
| "pages": [ | ||
| "capabilities/manipulation/readme", | ||
| "capabilities/manipulation/adding_a_custom_arm", | ||
| "capabilities/manipulation/openarm_integration" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Memory", | ||
| "pages": [ | ||
| "capabilities/memory/index", | ||
| "capabilities/memory/plot", | ||
| "capabilities/memory/algo_comparison" | ||
| ] | ||
| }, | ||
| "capabilities/perception/readme" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Platforms", | ||
| "pages": [ | ||
| "platforms/quadruped/go2/index", | ||
| "platforms/humanoid/g1/index" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Development", | ||
| "pages": [ | ||
| "development/docker", | ||
| "development/testing", | ||
| "development/grid_testing", | ||
| "development/large_file_management", | ||
| "development/profiling_dimos", | ||
| "development/writing_docs" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "For Agents", | ||
| "pages": [ | ||
| "agents/index", | ||
| "agents/style", | ||
| "agents/testing", | ||
| { | ||
| "group": "Writing Docs", | ||
| "pages": [ | ||
| "agents/docs/index", | ||
| "agents/docs/codeblocks", | ||
| "agents/docs/doclinks" | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| "logo": { | ||
| "light": "/assets/dimensional-logo-master-transparent.png", | ||
| "dark": "/assets/dimensional-logo-master-transparent.png" | ||
| }, | ||
| "navbar": { | ||
| "links": [ | ||
| { | ||
| "label": "Dimensional", | ||
| "href": "/" | ||
| } | ||
| ], | ||
| "primary": { | ||
| "type": "button", | ||
| "label": "Get started", | ||
| "href": "https://github.com/dimensionalOS/dimos" | ||
| } | ||
| }, | ||
| "contextual": { | ||
| "options": [ | ||
| "copy", | ||
| "view", | ||
| "chatgpt", | ||
| "claude", | ||
| "perplexity", | ||
| "mcp", | ||
| "cursor", | ||
| "vscode" | ||
| ] | ||
| }, | ||
| "footer": { | ||
| "socials": { | ||
| "github": "https://github.com/dimensionalOS/dimos" | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| title: "Welcome to Dimensional" | ||
| description: "An open source modern operating system for generalist robotics. Python-first, ROS-optional, and agent native." | ||
| sidebarTitle: Introduction | ||
| --- | ||
|
|
||
| **Dimensional** is the modern operating system for generalist robotics. We are setting the next-generation SDK standard and integrating with the majority of robot manufacturers. | ||
|
|
||
| With a simple install and no ROS required, you can build physical applications entirely in Python that run on humanoids, quadrupeds, or drones. | ||
|
|
||
| Dimensional is agent native, describe behavior in natural language and build local and hosted multi-agent systems that work with your hardware. Agents run as native modules, subscribing to embedded streams from perception (LiDAR, camera) and spatial memory down to control loops and motor drivers. | ||
|
|
||
| ## Capabilities at a glance | ||
|
|
||
| <Columns cols={2}> | ||
| <Card title="Navigation & mapping" icon="map" href="/capabilities/navigation/readme"> | ||
| **SLAM**, dynamic obstacle avoidance, route planning, and autonomous exploration- via both DimOS native and ROS integrations. | ||
|
Contributor
There was a problem hiding this comment.
Neither |
||
| </Card> | ||
| <Card title="Perception" icon="eye" href="/capabilities/perception/readme"> | ||
| Detectors, 3D projections, VLMs, and audio processing. | ||
| </Card> | ||
| <Card title="Agents" icon="robot" href="/capabilities/agents/readme"> | ||
| Agentive control and MCP. Example: *"Hey robot, go find the kitchen."* | ||
| </Card> | ||
| <Card title="Spatial memory" icon="brain" href="/capabilities/memory/index"> | ||
| Spatio-temporal RAG, dynamic memory, object localization and permanence. | ||
| </Card> | ||
| </Columns> | ||
|
|
||
| ## Start here | ||
|
|
||
| Use these pages to continue setup and then learn the core system model: | ||
|
|
||
| <Columns cols={2}> | ||
| <Card title="Quickstart" icon="rocket" href="/quickstart"> | ||
| Install DimOS, run your first blueprint, and inspect the running system. | ||
| </Card> | ||
| <Card title="DimOS concepts" icon="diagram-project" href="/usage/README"> | ||
| Learn the core system model: modules, streams, blueprints, skills, and agents. | ||
| </Card> | ||
| </Columns> | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lfs: trueto pull down the actual PNG binaries instead of the 130-byte LFS pointer stubs. Without this,mint validateand any downstream deployment step sees invalid image files for the logo and favicon.