Skip to content

Commit 23a6312

Browse files
worksofliamworksofliam
committed
Improved landing page
Signed-off-by: worksofliam <mrliamallan@live.co.uk>
1 parent d9409bc commit 23a6312

File tree

8 files changed

+179
-176
lines changed

8 files changed

+179
-176
lines changed

‎astro.config.mjs‎

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ export default defineConfig({
1010
trailingSlash: 'always',
1111
integrations: [
1212
starlight({
13+
pagination: false,
1314
title: 'Code for IBM i Docs',
1415
logo: {
1516
src: './public/icon.png',
@@ -23,7 +24,7 @@ export default defineConfig({
2324
baseUrl: 'https://github.com/codefori/docs/edit/main/'
2425
},
2526
customCss: [
26-
'./src/styles/custom.css',
27+
'./src/styles/custom.css',
2728
],
2829
sidebar:
2930
[
@@ -32,16 +33,16 @@ export default defineConfig({
3233
link: '/',
3334
},
3435
{
35-
label: 'Login',
36-
link: 'login/',
37-
badge: {
38-
variant: 'note',
39-
text: 'Start Here!'
40-
}
36+
label: 'Install',
37+
link: 'install/',
4138
},
4239
{
4340
label: 'Quick Start',
4441
link: 'quickstart/',
42+
badge: {
43+
variant: 'note',
44+
text: 'Start Here!'
45+
}
4546
},
4647
{
4748
label: 'Help and Support',
@@ -126,20 +127,20 @@ export default defineConfig({
126127

127128
],
128129
defaultLocale: 'root',
129-
locales: {
130-
root: {
131-
label: 'English',
132-
lang: 'en',
133-
},
134-
da: {
135-
label: 'Dansk',
136-
lang: 'da',
137-
},
138-
fr: {
139-
label: 'Français',
140-
lang: 'fr',
141-
},
142-
},
130+
// locales: {
131+
// root: {
132+
// label: 'English',
133+
// lang: 'en',
134+
// },
135+
// da: {
136+
// label: 'Dansk',
137+
// lang: 'da',
138+
// },
139+
// fr: {
140+
// label: 'Français',
141+
// lang: 'fr',
142+
// },
143+
// },
143144
}),
144145
],
145146
markdown: {

‎src/assets/codefori.png‎

171 KB
Loading

‎src/content/docs/dev/getting_started.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ To build a .`vsix` of the extension, you can use:
2222
npm run package
2323
```
2424

25+
### Developing the docs
26+
27+
To work on this documentation:
28+
29+
- clone repo docs repo: github.com/codefori/docs
30+
- install astro ```npm i```
31+
- run local with ```npm run dev```
32+
- by default, runs on http://localhost:4321/docs/
33+
- test build with ```npm run build```
34+
- Read more about [Astro](https://starlight.astro.build/getting-started/)<Icon name="rocket" color="rebeccapurple" class="icon-inline" />
35+
36+
2537
### Running tests
2638

2739
We have two types of test suites:

‎src/content/docs/help-and-support.mdx‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ title: Help and Support
44

55
import { Aside, CardGrid, Card } from '@astrojs/starlight/components';
66

7-
## How to get help and support
8-
97
<CardGrid>
108

119
<Card>

‎src/content/docs/index.mdx‎

Lines changed: 32 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,42 @@
11
---
22
title: Code for IBM i
33
description: Maintain and compile your RPGLE, CL, COBOL, C/CPP on the IBM i right from Visual Studio Code
4+
template: splash
5+
hero:
6+
tagline: Maintain and compile your RPGLE, CL, COBOL, C/CPP on the IBM i right from Visual Studio Code
7+
image:
8+
file: ../../assets/codefori.png
9+
actions:
10+
- text: Installation
11+
link: /docs/install/
12+
icon: right-arrow
13+
variant: primary
14+
- text: Quick start
15+
link: /docs/quickstart/
16+
icon: information
417
---
518

619
import { CardGrid, Card, Badge, LinkCard, Icon } from '@astrojs/starlight/components';
720

8-
Maintain and compile your RPGLE, CL, COBOL, C/CPP on the IBM i right from Visual Studio Code.
9-
10-
#### Getting started 🚀
11-
12-
<CardGrid>
13-
<LinkCard title="Installing" href="#installation" description="How to get Code for IBM i" />
14-
<LinkCard title="Compile some code" href="/docs/developing/editing-compiling/" description="Compile your RPGLE, COBOL or CL" />
15-
</CardGrid>
16-
17-
#### Write some code 🛠️
18-
19-
<CardGrid>
20-
<LinkCard title="RPGLE" href="/docs/extensions/rpgle/" description="See how VS Code can help you write modern RPGLE" />
21-
<LinkCard title="Db2 for IBM i" href="/docs/extensions/db2i/" description="Understand how to work with the database" />
22-
</CardGrid>
23-
24-
#### Extras 👀
21+
<hr />
2522

2623
<CardGrid>
27-
<LinkCard title="Terminals" href="/docs/tips/terminals/" description="Open 5250 right from VS Code" />
28-
<LinkCard title="IBM i and git" href="/docs/developing/local/getting-started/" description="Want to use git with IBM i?" />
24+
<Card title="Installing" icon="approve-check">
25+
Learn how to <a href="/docs/install/">install Code for IBM i</a>
26+
</Card>
27+
<Card title="Compile some code" icon="document">
28+
<a href="/docs/developing/editing-compiling/">Compile your RPGLE, COBOL or CL</a>
29+
</Card>
30+
<Card title="RPGLE" icon="approve-check-circle">
31+
<a href="/docs/extensions/rpgle/">See how VS Code can help you write modern RPGLE</a>
32+
</Card>
33+
<Card title="Db2 for IBM i" icon="seti:db">
34+
<a href="/docs/extensions/db2i/">Understand how to work with the database</a>
35+
</Card>
36+
<Card title="Terminals" icon="bars">
37+
<a href="/docs/tips/terminals/">Open 5250 right from VS Code</a>
38+
</Card>
39+
<Card title="IBM i and git" icon="seti:git">
40+
<a href="/docs/developing/local/getting-started/">Want to use git with IBM i?</a>
41+
</Card>
2942
</CardGrid>
30-
31-
---
32-
33-
![intro_01.png](../../assets/intro_01.png)
34-
35-
## Requirements
36-
37-
- IBM i 7.3 TR 5 minimum
38-
- SSH Daemon must be started on IBM i.
39-
- (Licensed program 5733-SC1 provides SSH support.)
40-
- `STRTCPSVR *SSHD` starts the daemon.
41-
- User `QSSHD` is enabled.
42-
- Some familiarity with VS Code. An introduction can be found [here](https://code.visualstudio.com/docs/getstarted/introvideos)<Icon name="external" color="cyan" class="icon-inline" />.
43-
44-
Optionally, ensure you know how to connect to pase from a shell. See this [official IBM i OSS docs](https://ibmi-oss-docs.readthedocs.io/en/latest/user_setup/README.html#step-1-install-an-ssh-client)<Icon name="external" color="cyan" class="icon-inline" />.
45-
46-
## Installation
47-
48-
<CardGrid>
49-
50-
<Card>
51-
52-
From the Visual Studio Code Marketplace: [Code for IBM i](https://marketplace.visualstudio.com/items?itemName=HalcyonTechLtd.code-for-ibmi)<Icon name="external" color="cyan" class="icon-inline" />
53-
54-
Or from the Extensions view inside of Visual Studio Code.
55-
56-
</Card><Card>
57-
58-
![install_01,png](../../assets/install_01.png)
59-
60-
</Card></CardGrid>
61-
62-
### Recommended Extensions
63-
64-
It's recommended you also install the [IBM i Development Pack](https://marketplace.visualstudio.com/items?itemName=HalcyonTechLtd.ibm-i-development-pack)<Icon name="external" color="cyan" class="icon-inline" />, a curated set of extensions built on or adding value to Code for IBM i. This includes database tools, RPGLE tools, COBOL tools, and more.
65-
66-
## Extension Development
67-
68-
Check out our [Developer documentation](./dev/getting_started/) page!
69-
70-
## Getting Started
71-
72-
To work on this documentation:
73-
74-
- clone repo
75-
- install astro ```npm i```
76-
- run local with ```npm run dev```
77-
- by default, runs on http://localhost:4321/docs/
78-
- test build with ```npm run build```
79-
- Read more about [Astro](https://starlight.astro.build/getting-started/)<Icon name="rocket" color="rebeccapurple" class="icon-inline" />

‎src/content/docs/install.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Installation
3+
---
4+
5+
import { CardGrid, Card, Badge, LinkCard, Icon } from '@astrojs/starlight/components';
6+
7+
![intro_01.png](../../assets/intro_01.png)
8+
9+
## Requirements
10+
11+
- IBM i 7.3 TR 5 minimum
12+
- SSH Daemon must be started on IBM i.
13+
- (Licensed program 5733-SC1 provides SSH support.)
14+
- `STRTCPSVR *SSHD` starts the daemon.
15+
- User `QSSHD` is enabled.
16+
- Some familiarity with VS Code. An introduction can be found [here](https://code.visualstudio.com/docs/getstarted/introvideos)<Icon name="external" color="cyan" class="icon-inline" />.
17+
18+
Optionally, ensure you know how to connect to pase from a shell. See this [official IBM i OSS docs](https://ibmi-oss-docs.readthedocs.io/en/latest/user_setup/README.html#step-1-install-an-ssh-client)<Icon name="external" color="cyan" class="icon-inline" />.
19+
20+
## Installation
21+
22+
<CardGrid>
23+
24+
<Card>
25+
26+
From the Visual Studio Code Marketplace: [Code for IBM i](https://marketplace.visualstudio.com/items?itemName=HalcyonTechLtd.code-for-ibmi)<Icon name="external" color="cyan" class="icon-inline" />
27+
28+
Or from the Extensions view inside of Visual Studio Code.
29+
30+
</Card><Card>
31+
32+
![install_01,png](../../assets/install_01.png)
33+
34+
</Card></CardGrid>
35+
36+
### Recommended Extensions
37+
38+
It's recommended you also install the [IBM i Development Pack](https://marketplace.visualstudio.com/items?itemName=HalcyonTechLtd.ibm-i-development-pack)<Icon name="external" color="cyan" class="icon-inline" />, a curated set of extensions built on or adding value to Code for IBM i. This includes database tools, RPGLE tools, COBOL tools, and more.
39+
40+
## Extension Development
41+
42+
Check out our [Developer documentation](./dev/getting_started/) page!

‎src/content/docs/login.mdx‎

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

0 commit comments

Comments
 (0)