Skip to content

Commit fb5ab30

Browse files
Nick-MazukNick-Mazuk
committed
add help docs
1 parent c78c745 commit fb5ab30

13 files changed

Lines changed: 524 additions & 80 deletions

File tree

‎cypress/integration/help/index.test.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
it('renders', () => {
2+
cy.visit('/help')
3+
cy.injectAxe()
4+
cy.checkA11y()
5+
})
6+
7+
export {}

‎cypress/integration/help/install/mac.test.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
it('renders', () => {
2+
cy.visit('/help/install/mac')
3+
cy.injectAxe()
4+
cy.checkA11y()
5+
})
6+
7+
export {}

‎cypress/integration/install.test.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
it('renders', () => {
2+
cy.visit('/install')
3+
cy.injectAxe()
4+
cy.checkA11y()
5+
})
6+
7+
export {}

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"@nick-mazuk/eslint-config": "0.8.13",
2222
"@nick-mazuk/ui-config": "0.10.63",
2323
"@sveltejs/adapter-vercel": "1.0.0-next.26",
24-
"@sveltejs/kit": "^1.0.0-next.113",
24+
"@sveltejs/kit": "^1.0.0-next.138",
2525
"@types/fs-extra": "^9.0.9",
2626
"@types/js-search": "^1.4.0",
2727
"autoprefixer": "^10.2.5",
@@ -41,7 +41,7 @@
4141
},
4242
"dependencies": {
4343
"@nick-mazuk/lib": "^0.8.54",
44-
"@nick-mazuk/ui-svelte": "0.26.4",
44+
"@nick-mazuk/ui-svelte": "0.26.5",
4545
"@sveltejs/adapter-static": "^1.0.0-next.13",
4646
"date-fns": "^2.23.0",
4747
"i": "^0.3.6",

‎pnpm-lock.yaml‎

Lines changed: 81 additions & 75 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/lib/lib/library-pages.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
export const libraryPages: any[] = [
1+
import type { TocItems } from '@nick-mazuk/ui-svelte/src/components/table-of-contents';
2+
3+
export const libraryPages: TocItems = [
24
{
35
text: 'Getting Started',
46
href: '/docs/getting-started',

‎src/routes/__error.svelte‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
message="Looks like the page you're looking for doesn't exist. This is just as frustrating as another Finale bug!"
2626
links="{[
2727
{ href: '/', text: 'Home' },
28-
{ href: '/docs/getting-started', text: 'Docs' },
28+
{ href: '/help', text: 'Help' },
29+
{ href: '/docs/getting-started', text: 'Developer docs' },
2930
]}"
3031
/>
3132
{:else}

‎src/routes/__layout.svelte‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<script>
1+
<script lang="ts">
22
import { page } from '$app/stores'
33
44
import ResetItems from '$lib/components/reset-items.svelte'
@@ -8,6 +8,7 @@
88
import HeaderLink from '@nick-mazuk/ui-svelte/src/components/header/header-link/header-link.svelte'
99
import HeaderMobileLink from '@nick-mazuk/ui-svelte/src/components/header/header-mobile-link/header-mobile-link.svelte'
1010
import HeaderMobileSubgroup from '@nick-mazuk/ui-svelte/src/components/header/header-mobile-subgroup/header-mobile-subgroup.svelte'
11+
import type { TocItems } from '@nick-mazuk/ui-svelte/src/components/table-of-contents'
1112
import Github from '@nick-mazuk/ui-svelte/src/elements/icon/github.svelte'
1213
1314
import Footer from '@nick-mazuk/ui-svelte/src/components/footer/footer.svelte'
@@ -19,6 +20,35 @@
1920
import { libraryPages } from '../lib/lib/library-pages'
2021
2122
const githubRepoUrl = 'https://github.com/Nick-Mazuk/jw-lua-scripts'
23+
24+
const helpPages: TocItems = [
25+
{
26+
text: 'Install scripts',
27+
href: '/help/install',
28+
children: [
29+
{
30+
text: 'macOS',
31+
href: '/help/install/mac',
32+
},
33+
{
34+
text: 'Windows',
35+
href: '/help/install/windows',
36+
},
37+
],
38+
},
39+
{
40+
text: 'Request script',
41+
href: 'https://github.com/Nick-Mazuk/jw-lua-scripts/issues/new/choose',
42+
},
43+
{
44+
text: 'Report bug',
45+
href: 'https://github.com/Nick-Mazuk/jw-lua-scripts/issues/new/choose',
46+
},
47+
{
48+
text: 'Contribute',
49+
href: '/docs/getting-started',
50+
},
51+
]
2252
</script>
2353

2454
<svelte:head>
@@ -30,10 +60,14 @@
3060
<Header sticky page="{$page.path}">
3161
<HeaderBrand text="JW Lua Scripts" slot="left" />
3262
<svelte:fragment slot="right">
63+
<HeaderLink href="/help">Help</HeaderLink>
3364
<HeaderLink href="/docs/getting-started">Develper docs</HeaderLink>
3465
<HeaderLink href="{githubRepoUrl}"><Github title="Github" size="{6}" /></HeaderLink>
3566
</svelte:fragment>
3667
<svelte:fragment slot="mobile">
68+
<HeaderMobileSubgroup items="{helpPages}" basePath="/help">
69+
<HeaderMobileLink href="/help" slot="main">Help</HeaderMobileLink>
70+
</HeaderMobileSubgroup>
3771
<HeaderMobileSubgroup items="{libraryPages}" basePath="/docs">
3872
<HeaderMobileLink href="/docs/getting-started" slot="main">
3973
Developer docs

‎src/routes/help/index.svelte‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<script lang="ts">
2+
import Container from '@nick-mazuk/ui-svelte/src/utilities/container/container.svelte'
3+
import Download from '@nick-mazuk/ui-svelte/src/elements/marketing-icon/download.svelte'
4+
import Bug from '@nick-mazuk/ui-svelte/src/elements/marketing-icon/bug.svelte'
5+
import HandsHelping from '@nick-mazuk/ui-svelte/src/elements/marketing-icon/hands-helping.svelte'
6+
import LightbulbOn from '@nick-mazuk/ui-svelte/src/elements/marketing-icon/lightbulb-on.svelte'
7+
8+
import Seo from '@nick-mazuk/ui-svelte/src/utilities/seo/seo.svelte'
9+
import Spacer from '@nick-mazuk/ui-svelte/src/utilities/spacer/spacer.svelte'
10+
</script>
11+
12+
<Seo title="Help" siteName="JW Lua Scripts" />
13+
14+
<main id="main-content">
15+
<div class="wrapper !max-w-2xl my-12">
16+
<h1 class="h4 text-center">What do you need help with?</h1>
17+
<Spacer />
18+
<div class="grid grid-cols-2 gap-6">
19+
<Container
20+
padding="{8}"
21+
href="/help/install"
22+
class="flex flex-col items-center space-y-6"
23+
>
24+
<Download class="h-12" variant="gray" />
25+
<p class="text-lg">Install scripts</p>
26+
</Container>
27+
<Container
28+
padding="{8}"
29+
href="https://github.com/Nick-Mazuk/jw-lua-scripts/issues/new/choose"
30+
class="flex flex-col items-center space-y-6"
31+
>
32+
<LightbulbOn class="h-12" variant="gray" />
33+
<p class="text-lg">Request script</p>
34+
</Container>
35+
<Container
36+
padding="{8}"
37+
href="https://github.com/Nick-Mazuk/jw-lua-scripts/issues/new/choose"
38+
class="flex flex-col items-center space-y-6"
39+
>
40+
<Bug class="h-12" variant="gray" />
41+
<p class="text-lg">Report bug</p>
42+
</Container>
43+
<Container
44+
padding="{8}"
45+
href="/docs/getting-started"
46+
class="flex flex-col items-center space-y-6"
47+
>
48+
<HandsHelping class="h-12" variant="gray" />
49+
<p class="text-lg">Contribute</p>
50+
</Container>
51+
</div>
52+
</div>
53+
</main>

‎src/routes/help/install/index.svelte‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<script lang="ts">
2+
import Container from '@nick-mazuk/ui-svelte/src/utilities/container/container.svelte'
3+
import Apple from '@nick-mazuk/ui-svelte/src/elements/icon/apple.svelte'
4+
import Windows from '@nick-mazuk/ui-svelte/src/elements/icon/windows.svelte'
5+
6+
import Seo from '@nick-mazuk/ui-svelte/src/utilities/seo/seo.svelte'
7+
import Spacer from '@nick-mazuk/ui-svelte/src/utilities/spacer/spacer.svelte'
8+
</script>
9+
10+
<Seo title="Install" siteName="JW Lua Scripts" />
11+
12+
<main id="main-content">
13+
<div class="wrapper !max-w-2xl my-6">
14+
<h1 class="h4 text-center">Using JW Lua scripts</h1>
15+
<Spacer y="{0.5}" />
16+
<p class="text-center">Select your operating system</p>
17+
<Spacer />
18+
<div class="grid grid-cols-2 gap-6">
19+
<Container
20+
padding="{8}"
21+
href="/help/install/mac"
22+
class="flex flex-col items-center space-y-6"
23+
>
24+
<Apple size="{12}" color="--c-gray" />
25+
<p class="text-lg">macOS</p>
26+
</Container>
27+
<Container
28+
padding="{8}"
29+
href="/help/install/windows"
30+
class="flex flex-col items-center space-y-6"
31+
>
32+
<Windows size="{12}" color="--c-gray" />
33+
<p class="text-lg">Windows</p>
34+
</Container>
35+
</div>
36+
</div>
37+
</main>

0 commit comments

Comments
 (0)