Skip to content

Commit e1c716f

Browse files
docs(website): change get started to introduction
1 parent 8462489 commit e1c716f

File tree

9 files changed

+20
-16
lines changed

9 files changed

+20
-16
lines changed

packages/overmind-website/src/components/App/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ import MobileTopBar from '../MobileTopBar'
1212
import { useIsMobile, useScrollToPosition } from '../../utils'
1313
import Footer from '../Footer'
1414
import { hot } from 'react-hot-loader/root'
15-
import GetStarted from '../GetStarted'
15+
import Introduction from '../Introduction'
1616

1717
const pages = {
1818
[Page.HOME]: FrontPage,
19-
[Page.GETSTARTED]: GetStarted,
19+
[Page.INTRODUCTION]: Introduction,
2020
[Page.GUIDES]: Guides,
2121
[Page.GUIDE]: Guide,
2222
[Page.API]: Api,

packages/overmind-website/src/components/GetStarted/index.tsx renamed to packages/overmind-website/src/components/Introduction/index.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import { compile, getGithubBaseUrl } from '../../utils'
55
import Doc from '../Doc'
66
import GuideToc from '../GuideToc'
77

8-
const GetStarted: SFC = () => {
8+
const Introduction: SFC = () => {
99
const { state } = useOvermind()
1010
const [content, setContent] = useState(null)
1111

1212
useEffect(() => {
13-
import('./getstarted.md').then((module) => setContent(module.default))
13+
import('./introduction.md').then((module) => setContent(module.default))
1414
}, [])
1515

1616
if (!content) {
@@ -29,4 +29,4 @@ const GetStarted: SFC = () => {
2929
)
3030
}
3131

32-
export default GetStarted
32+
export default Introduction

packages/overmind-website/src/components/GetStarted/getstarted.md renamed to packages/overmind-website/src/components/Introduction/introduction.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# Get Started
1+
# Welcome to Overmind
22

3-
Welcome to Overmind. In this guide you will get an introduction to Overmind and how you can think about application development. We will be using [React](https://reactjs.org/) to write the UI, but you can use also use Overmind with [Vue](https://vuejs.org/) and [Angular](https://angular.io).
3+
In this introduction you will get an overview of Overmind and how you can think about application development. We will be using [React](https://reactjs.org/) to write the UI, but you can use also use Overmind with [Vue](https://vuejs.org/) and [Angular](https://angular.io).
4+
5+
```marksy
6+
h(Notice, null, "If you rather want to go right ahead and set up a local project, please have a look at the [quickstart](/guides/beginner/01_quickstart) guide.")
7+
```
48

59
Before we move on, have a quick look at this sandbox. It is a simple counter application and it gives you some foundation before talking more about Overmind and building applications.
610

packages/overmind-website/src/components/GetStarted/styles.ts renamed to packages/overmind-website/src/components/Introduction/styles.ts

File renamed without changes.

packages/overmind-website/src/components/MobileTopBar/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ const MobileTopBar: SFC = () => {
4747
Home
4848
</a>
4949
<a
50-
href="/getstarted"
50+
href="/introduction"
5151
className={css(
5252
styles.link,
53-
state.page === Page.GETSTARTED && styles.linkSelected
53+
state.page === Page.INTRODUCTION && styles.linkSelected
5454
)}
5555
>
5656
Get started

packages/overmind-website/src/components/TopBar/index.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ const TopBar: SFC = () => {
3232
Home
3333
</a>
3434
<a
35-
href="/getstarted"
35+
href="/introduction"
3636
className={css(
3737
styles.link,
38-
state.page === Page.GETSTARTED && styles.selected
38+
state.page === Page.INTRODUCTION && styles.selected
3939
)}
4040
>
41-
Get Started
41+
Introduction
4242
</a>
4343
<a
4444
href="/guides"

packages/overmind-website/src/overmind/actions.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ export const openHome: AsyncAction<RouteContext> = withRoute(
3838
}
3939
)
4040

41-
export const openGetStarted: AsyncAction<RouteContext> = withRoute(
41+
export const openIntroduction: AsyncAction<RouteContext> = withRoute(
4242
async ({ state }) => {
43-
state.page = Page.GETSTARTED
43+
state.page = Page.INTRODUCTION
4444
}
4545
)
4646

packages/overmind-website/src/overmind/onInitialize.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const onInitialize: OnInitialize = async ({ effects, state, actions }) => {
44
state.showViewHelp = !effects.storage.get('theme')
55

66
effects.router.route('/', actions.openHome)
7-
effects.router.route('/getstarted', actions.openGetStarted)
7+
effects.router.route('/introduction', actions.openIntroduction)
88
effects.router.route('/guides', actions.openGuides)
99
effects.router.route('/guides/:type/:title', actions.openGuide)
1010
effects.router.route('/videos', actions.openVideos)

packages/overmind-website/src/overmind/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export type ApiParams = {
3030

3131
export enum Page {
3232
HOME = 'HOME',
33-
GETSTARTED = 'GETSTARTED',
33+
INTRODUCTION = 'INTRODUCTION',
3434
GUIDES = 'GUIDES',
3535
GUIDE = 'GUIDE',
3636
VIDEOS = 'VIDEOS',

0 commit comments

Comments
 (0)