Skip to content

Commit 6e4fcef

Browse files
author
Xintong Xia
authored
add all the docs pages (#159)
- `Streetscape.gl` -> `streetscape.gl` - add all the doc pages
1 parent 4f334c1 commit 6e4fcef

21 files changed

+70
-266
lines changed

.gitattributes

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ yarn.lock -diff
99

1010
*.png -diff
1111

12-
website/styles/Streetscape.json -diff
12+
website/streetscape.gl.json -diff

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
*Uber Confidential Information*
22

3-
# Streetscape.gl
3+
# streetscape.gl
44

55
### Dependencies
66

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Streetscape.gl
1+
# streetscape.gl
22

33
*Uber Confidential Information*
44

docs/develop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ $ yarn test-browser
4343

4444
## Dependency setup for Local Development
4545

46-
To improve the development flow while working on both XVIZ and Streetscape.gl it is useful to directly link the dependencies rather than use packages.
46+
To improve the development flow while working on both XVIZ and streetscape.gl it is useful to directly link the dependencies rather than use packages.
4747

4848
We have some utility script to use yarn linking between XVIZ
4949

modules/core/src/index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
// The generic XVIZ layer
2626
export {default as XVIZLayer} from './layers/xviz-layer';
2727

28-
// Streetscape.gl custom layers
28+
// streetscape.gl custom layers
2929
export {default as SignLayer} from './layers/sign-layer/sign-layer';
3030
export {default as TrafficLightLayer} from './layers/traffic-light-layer/traffic-light-layer';
3131
export {default as ImageryLayer} from './layers/imagery-layer/imagery-layer';

website/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ yarn start-local
1515

1616
## Development
1717

18-
### Streetscape styles
18+
### streetscape styles
1919

2020
#### How to update
2121

website/documentation/html.config.js

-30
This file was deleted.

website/documentation/package.json

-13
This file was deleted.

website/documentation/src/config.js

-54
This file was deleted.

website/documentation/src/demos.js

-21
This file was deleted.

website/documentation/src/mdRoutes.js

-116
This file was deleted.

website/documentation/src/styles/_variables.scss

-13
This file was deleted.

website/documentation/src/styles/index.scss

Whitespace-only changes.

website/documentation/static/.gitkeep

Whitespace-only changes.
-5.39 MB
Binary file not shown.

website/pages.json

+59-8
Original file line numberDiff line numberDiff line change
@@ -74,16 +74,67 @@
7474
"name": "API Reference",
7575
"children": [
7676
{
77-
"name": "LogViewer",
78-
"markdown": "api-reference/log-viewer.md"
77+
"name": "Loaders",
78+
"children": [
79+
{
80+
"name": "XVIZLoaderInterface",
81+
"markdown": "api-reference/xviz-loader-interface.md"
82+
},
83+
{
84+
"name": "XVIZStreamLoader",
85+
"markdown": "api-reference/xviz-stream-loader.md"
86+
},
87+
{
88+
"name": "XVIZFileLoader",
89+
"markdown": "api-reference/xviz-file-loader.md"
90+
}
91+
]
7992
},
8093
{
81-
"name": "XVIZLoaderInterface",
82-
"markdown": "api-reference/xviz-loader-interface.md"
83-
},
84-
{
85-
"name": "XVIZStreamLoader",
86-
"markdown": "api-reference/xviz-stream-loader.md"
94+
"name": "React Components",
95+
"children": [
96+
{
97+
"name": "Log Viewer",
98+
"markdown": "api-reference/log-viewer.md"
99+
},
100+
{
101+
"name": "Playback Control",
102+
"markdown": "api-reference/playback-control.md"
103+
},
104+
{
105+
"name": "Stream Settings",
106+
"markdown": "api-reference/stream-settings-panel.md"
107+
},
108+
{
109+
"name": "XVIZ panel",
110+
"children": [
111+
{
112+
"name": "XVIZ panel",
113+
"markdown": "api-reference/xviz-panel.md"
114+
},
115+
{
116+
"name": "XVIZ Panel Component",
117+
"markdown": "api-reference/xviz-panel-component.md"
118+
},
119+
{
120+
"name": "XVIZ Metric Component",
121+
"markdown": "api-reference/xviz-metric-component.md"
122+
},
123+
{
124+
"name": "XVIZ Plot Component",
125+
"markdown": "api-reference/xviz-plot-component.md"
126+
},
127+
{
128+
"name": "XVIZ Video Component",
129+
"markdown": "api-reference/xviz-video-component.md"
130+
},
131+
{
132+
"name": "XVIZ Table Component",
133+
"markdown": "api-reference/xviz-table-component.md"
134+
}
135+
]
136+
}
137+
]
87138
}
88139
]
89140
}

website/src/components/header.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export default class Header extends Component {
7373
<i className="icon icon-github" />
7474
</a>
7575
<NavLink activeClassName="active" to="/streetscape.gl">
76-
Streetscape.gl
76+
streetscape.gl
7777
</NavLink>
7878
<a href={STREETSCAPE_GITHUB_URL} className="external">
7979
<i className="icon icon-github" />

website/src/components/hero.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ export default class Hero extends PureComponent {
203203
Make an leap with your autonomous vehicle data
204204
</div>
205205
<div className="sg-home__caption__description">
206-
<span>Streetscape.gl is a powerful </span>
206+
<span>streetscape.gl is a powerful </span>
207207
<span className="t-bold">open source </span>
208208
<span>web-based 3D visualization framework for </span>
209209
<span className="t-bold">full-stack </span>

website/src/static/images/logo.png

553 Bytes
Loading

0 commit comments

Comments
 (0)