Skip to content

Commit acb1fbd

Browse files
committed
add docs for accepted url hash input formats
1 parent d00fb28 commit acb1fbd

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
# Accepted URL Input hash schemes
6+
7+
3DStreet can import third-party street data in a variety of formats. The following URL input hash schemes are accepted:
8+
9+
| Scheme | Description | Usage Example |
10+
| --------- | -- |-- |
11+
| `streetmix-url` | Streetmix User-Facing Street URL | `https://3dstreet.app/#https://streetmix.net/kfarr/3/3dstreet-demo-street` |
12+
| `streetplan-url` | StreetPlan API URL | `https://3dstreet.app/#https://streetplan.net/3dstreet/89241` |
13+
| `managed-street-json` | Managed Street JSON Blob | `https://3dstreet.app/#managed-street-json:{"data":"value"}` |
14+
| `cloud-uuid` (legacy) | 3DStreet Scene JSON Format from Cloud UUID | `https://3dstreet.app/#scenes/bc72ab26-891d-417b-a50f-0cf84621a54c.json` |
15+
| `cloud-uuid` (proposed) | 3DStreet Scene JSON Format from Cloud UUID | `https://3dstreet.app/#scenes/bc72ab26-891d-417b-a50f-0cf84621a54c` |

docs/development/overview-developer-documentation.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,10 @@ sidebar_position: 2
33
---
44

55
# Git Repositories
6-
3DStreet is made up of 4 key repositories:
6+
3DStreet is made up of these key repositories:
77

88
| Name | Repository & Endpoint | Description |
99
| --------- | -- |-- |
10-
| Core Parser & Viewer | GitHub: [3DStreet/3dstreet](https://github.com/3DStreet/3dstreet) <br /> Endpoint: https://github.3dstreet.org | A-Frame app to create 3D entities from 3DStreet scene file or Streetmix API response. Also creates basic environment and viewer controls. |
11-
| Editor | GitHub: [3DStreet/3dstreet-editor](https://github.com/3DStreet/3dstreet-editor) <br /> Endpoint: https://3dstreet.app | React-based interactive scene graph browser, interactive editor, and entity component property editor. |
10+
| Core & Editor | GitHub: [3DStreet/3dstreet](https://github.com/3DStreet/3dstreet) <br /> Endpoint: https://3dstreet.app | A-Frame and React-based interactive editor, street format parser and renderer.
1211
| Assets | GitHub: [3DStreet/3dstreet-assets-source](https://github.com/3DStreet/3dstreet-assets-source) <br /> GitHub: [3DStreet/3dstreet-assets-dist](https://github.com/3DStreet/3dstreet-assets-dist) <br /> Endpoint: https://assets.3dstreet.app | All original source files for 3DStreet 3D models including Blender source code as well as converted output for distribution. |
13-
| Docs & Website | GitHub: [3DStreet/3dstreet-docs](https://github.com/3DStreet/3dstreet-docs) <br /> Endpoint: https://3dstreet.org | This documentation site as well as 3dstreet.org index page. |
14-
15-
16-
### Future docs topics
17-
18-
- Contributing for Developers (for Kieran)
19-
- Architecture
20-
- Repositories
21-
- Contributing Instructions (issue, PR, testing, etc.)
22-
- Anatomy of `3DStreet` core repo index.html (script imports a-frame and components, viewer UI, street parser ...)
12+
| Docs & Website | GitHub: [3DStreet/3dstreet-docs](https://github.com/3DStreet/3dstreet-docs) <br /> Endpoint: https://3dstreet.org | This documentation site as well as 3dstreet.org index page. |

0 commit comments

Comments
 (0)