Skip to content

Commit ff8bcb3

Browse files
authored
Merge pull request #57 from 3DStreet/docs-edits
Docs edits
2 parents c84e105 + 5ae13d2 commit ff8bcb3

12 files changed

+18
-224
lines changed

docs/3dstreet-editor/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"label": "3DStreet Editor",
33
"position": 4,
44
"link": {
5-
"type": "generated-index",
6-
"description": "A collection of documentation for the 3DStreet Editor."
5+
"type": "doc",
6+
"id": "3dstreet-editor/overview-3dstreet-editor"
77
}
88
}

docs/3dstreet-editor/overview-3dstreet-editor.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22
sidebar_position: 1
33
---
44

5-
# Overview
6-
7-
## 3DStreet Editor
5+
# 3DStreet Editor
86

97
![Screenshot of the 3DStreet Editor application with user interface elements for modifying a street scene.](/img/docs/3dstreet-editor-screenshot.jpg)
108

docs/about-3dstreet/primary-metrics.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/about-3dstreet/user-personas.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/development/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/development/alpha-labs.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/development/overview-developer-documentation.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/development/releases.md

Lines changed: 0 additions & 119 deletions
This file was deleted.

docs/managed-street/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"label": "Managed Street (Beta)",
33
"position": 4,
44
"link": {
5-
"type": "generated-index",
6-
"description": "A collection of documentation for Managed Street format and UI."
5+
"type": "doc",
6+
"id": "managed-street/overview-managed-street"
77
}
88
}

docs/managed-street/managed-street-json-format.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ This document describes the JSON format for defining streets in the 3DStreet sys
1313
name: string, // Name of the street configuration
1414
width: number, // Total width in meters
1515
length: number, // Length of street in meters
16-
justifyWidth: string, // How to justify segments ("center")
17-
justifyLength: string, // How to justify street length ("start")
1816
segments: Segment[] // Array of segment definitions
1917
}
2018
```
@@ -182,6 +180,12 @@ Striping Types:
182180
}
183181
```
184182

183+
## Managed Street JSON Examples
184+
185+
These are the default street definitions in Managed Street JSON used in the 3DStreet Editor Add Layer Panel.
186+
187+
* [https://github.com/3DStreet/3dstreet/blob/main/src/editor/components/components/AddLayerPanel/defaultStreets.js](https://github.com/3DStreet/3dstreet/blob/main/src/editor/components/components/AddLayerPanel/defaultStreets.js)
188+
185189
## Notes
186190

187191
- All measurements should be in meters

docs/managed-street/overview-managed-street.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,15 @@
22
sidebar_position: 1
33
---
44

5-
# Overview
6-
7-
## Managed Street (Beta)
5+
# Managed Street (Beta)
86

97
"Managed Street" is a 3DStreet system composed of a "Managed Street JSON" format, JavaScript A-Frame components, and custom user interface elements that allow end-users to create, convert, and add procedural elements on a street path.
108

11-
## Using Managed Street
9+
# Using Managed Street
1210

1311
Users can create streets with the new Managed Street format using the 3DStreet Editor. Press the Add Layer button > Streets and Intersections tab > and scroll down to select a "(Beta) Managed Street..." card or drag-and-drop to a specific location in the viewport. These features are still in heavy development and are subject to change.
1412

15-
## Key elements
13+
# Key elements
1614

1715
- [Managed Street Component](./component-managed-street.md)
1816
- [Street Segment Component](./component-street-segment.md)

docusaurus.config.js

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,25 +139,21 @@ const config = {
139139
href: "https://www.linkedin.com/company/3dstreet/",
140140
},
141141
{
142-
label: "Mastadon",
143-
href: "https://urbanists.social/@3dstreet",
142+
label: "YouTube",
143+
href: "https://www.youtube.com/@3DStreetapp",
144144
},
145145
],
146146
},
147147
{
148148
title: "GitHub Repositories",
149149
items: [
150150
{
151-
label: "3DStreet Core (Parser and Viewer)",
151+
label: "3DStreet Core",
152152
href: "https://github.com/3dstreet/3dstreet",
153153
},
154-
{
155-
label: "3DStreet Editor",
156-
href: "https://github.com/3dstreet/3dstreet-editor",
157-
},
158154
{
159155
label: "3DStreet Assets",
160-
href: "https://github.com/3dstreet/3dstreet-assets-source",
156+
href: "https://github.com/3dstreet/3dstreet-assets-dist",
161157
},
162158
],
163159
},

0 commit comments

Comments
 (0)