Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Documentation UI #50

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/css/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:root {
/* --md-primary-fg-color: #c4c4c4; */
/* --md-primary-fg-color--light: #ECB7B7; */
/* --md-primary-fg-color--dark: #90030C; */
}

.md-grid {
max-width: 100%;
}
10 changes: 0 additions & 10 deletions docs/documentation.md

This file was deleted.

Binary file added docs/img/Surface-Tool.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
hide:
- navigation
- toc
---
# Home
## Docs and guides to work with the Truevision ecosystem.

10 changes: 10 additions & 0 deletions docs/manual/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Manual


![Image title](/img/welcome.jpg)

Use the Truevision Editor to create maps and scenarios. Download the Editor at [www.truevision.ai](https://www.truevision.ai)

The Truevision User Manual helps you learn how to use the Truevision Editor and its associated services. You can read it from start to finish, or use it as a reference.

If it’s your first time using Truevision, take a look at the introductory documentation on Working with Truevision, and refer to the Truevision Tutorials.
11 changes: 6 additions & 5 deletions docs/installation.md → docs/manual/installation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Getting Started: Installation
# Installation

- [Installation](#installation)
- [System Requirements](#system-requirements)
- [Installing On Ubuntu](#installing-on-ubuntu)
- [Launching](#launching)
- [Sign In](#sign-in)
- [Installation](#installation-1)
- [System Requirements](#system-requirements)
- [Installing On Ubuntu](#installing-on-ubuntu)
- [Launching Truevision](#launching-truevision)
- [Sign-In](#sign-in)

<a name="installation"></a>
## Installation
Expand Down
6 changes: 6 additions & 0 deletions docs/manual/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Quickstart

## Creating Simple Map

## Create Simple Scenario

52 changes: 52 additions & 0 deletions docs/manual/tools/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Tools

## Common Tools

| Road Tools | Description |
| -----------------|-------------------------------------------------|
| Pointer Tool | Tool to simply browse the scene |


## Road Tools

Tools which help in creating and editing roads

| Road Tools | Description |
| -----------------|-------------------------------------------------|
| Road Tool | Tool to create, edit and join roads |
| Circle Tool | Tool to create circular roads |
| Elevation Tool | Tool to create circular roads |


## Lane Tools

Tools which help in modifying lanes

| Tools |
| -----------------|
| Lane Tool |
| Lane Width Tool |
| Lane Offset Tool |
| Lane Add Tool |
| Lane Marking Tool|


## Prop Tools

Tools which help in adding props and objects in the scene

| Tools |
| -----------------|
| Prop Point Tool |
| Prop Curve Tool |
| Prop Polygon Tool |


## Scenario Tools

Tools which help in creating and editing actors and scenarios

| Tools |
| -----------------|
| Vehicle Tool |
| Pedestrian Tool |
3 changes: 0 additions & 3 deletions docs/lane-add-tool.md → docs/manual/tools/lane-add-tool.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Lane Add Tool

- [Overview](#overview)
- [Add Lane](#add-lane)


<a name="overview"></a>
## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Lane Width Tool

- [Overview](#overview)
- [Create Width Node](#create-width-node)


<a name="overview"></a>
## Overview
Expand All @@ -18,4 +15,4 @@ This tool helps you modify the width of a lane on the road. A single road lane c
- Take pointer over a lane and use `shift + left click` to create new node
- When the node is selected you will the node info in the inspector, modify the width value as desired

<img src="../../../img/docs/lane-width-create.png" width="100%">
<img src="../../../img/docs/lane-width-create.png" width="100%">
Empty file.
6 changes: 0 additions & 6 deletions docs/road-tool.md → docs/manual/tools/road-tool.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
# Road Tool

- [Overview](#overview)
- [Create Roads](#create-roads)
- [Select Road](#select-road)
- [Connect Roads](#connect-roads)


<a name="overview"></a>
## Overview

Expand Down
4 changes: 3 additions & 1 deletion docs/surface-tool.md → docs/manual/tools/surface-tool.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# SurfaceTool Usage Instructions
# SurfaceTool

## Create Surfaces
Hold the `Shift` key and `Left-click` on the desired location to create control points. Drag the control points to change the shape of the surface. To create a new surface, first unselect the previously created surface by left-clicking on an empty area. Then, hold `Shift` and `Left-click` again to start creating a new surface.

![Image title](/img/Surface-Tool.gif)

## Select Surface
Hover your mouse pointer over the surface and use `Left-click` to select it for editing and modification.

Expand Down
2 changes: 2 additions & 0 deletions docs/manual/user-interface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# User Interface

76 changes: 0 additions & 76 deletions docs/open-drive.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/overview.md

This file was deleted.

98 changes: 0 additions & 98 deletions docs/tools.md

This file was deleted.

Loading