Skip to content

Commit 051e0fe

Browse files
committed
feat(docs): Added new documentation site
resolves #55
1 parent 7e924da commit 051e0fe

136 files changed

Lines changed: 2998 additions & 2257 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/build_rust.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,20 @@ jobs:
1818
- name: Run Tests
1919
run: cargo test --target x86_64-unknown-linux-gnu
2020

21-
- name: Run Export Schemas
21+
- name: Export LCAx Schema
2222
run: cargo run --target x86_64-unknown-linux-gnu --package lcax --bin export-schema > lcax.schema.json
2323

24+
- name: Export Validation Schema
25+
run: cargo run --target x86_64-unknown-linux-gnu --package lcax_validation --bin export-schema > validation.schema.json
26+
2427
- name: Upload JSON Schema
2528
uses: actions/upload-artifact@v4
2629
with:
2730
name: json-schema
2831
path: 'lcax.schema.json'
2932

30-
- name: Upload Rust Schema
33+
- name: Upload Validation Schema
3134
uses: actions/upload-artifact@v4
3235
with:
33-
name: rust-schema
34-
path: 'modules/models/src/project.rs'
36+
name: validation-schema
37+
path: 'validation.schema.json'

.github/workflows/cicd.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ on:
44
push:
55
branches:
66
- main
7-
- v3.0
7+
- v3.x
88
pull_request:
99
branches:
1010
- main
11-
- v3.0
11+
- v3.x
1212
workflow_dispatch:
1313

1414
permissions:

.github/workflows/create_release.yaml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,9 @@ jobs:
3636

3737
- uses: actions/download-artifact@v4
3838
with:
39-
name: rust-schema
39+
name: validation-schema
4040
path: artifacts
4141
#
42-
# - uses: actions/download-artifact@v4
43-
# with:
44-
# name: csharp-schema
45-
# path: artifacts
46-
4742
- name: Set up Node.js
4843
uses: actions/setup-node@v4
4944
with:

.github/workflows/release_docs.yaml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ jobs:
2121

2222
- uses: actions/download-artifact@v4
2323
with:
24-
name: rust-schema
25-
path: docs/src/content/code/rust
24+
name: validation-schema
25+
path: docs/src/content/code
2626

2727
- uses: actions/download-artifact@v4
2828
with:
2929
name: changelog
30-
path: .
30+
path: docs/src/content/reference
3131

3232
- name: Set up Node
3333
uses: actions/setup-node@v4
@@ -38,12 +38,11 @@ jobs:
3838
working-directory: docs
3939
run: npm ci
4040

41-
- name: Construct Changelog
42-
run: cat CHANGELOG.md >> docs/src/content/docs/reference/changelog.md
43-
4441
- name: Build Docs
4542
working-directory: docs
4643
run: npm run build
44+
env:
45+
DOMAIN: docs.lcax.org
4746

4847
- name: Upload artifact for deployment job
4948
if: github.event_name != 'pull_request'

.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ downloads/
1515
eggs/
1616
.eggs/
1717
lib/
18+
!docs/app/lib/
1819
lib64/
1920
parts/
2021
sdist/
@@ -184,3 +185,16 @@ package-lock.json
184185
/packages/csharp/lcax/bin/
185186
/packages/csharp/lcax/obj/
186187
/modules/convert/tests/br_standard/datafixtures/914a0b0b-4b7f-498f-9349-16cf0d644766.xlsx
188+
189+
# next.js
190+
/.next/
191+
/out/
192+
193+
# production
194+
/build
195+
/docs/dist
196+
197+
# typescript
198+
*.tsbuildinfo
199+
next-env.d.ts
200+
/docs/.next/

.releaserc.yaml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
branches:
22
- "main"
3-
- name: "v3.0"
3+
- name: "v3.x"
44
prerelease: beta
55

66
preset: "conventionalcommits"
@@ -37,10 +37,7 @@ plugins:
3737
- - "@semantic-release/github"
3838
- assets:
3939
- { path: 'artifacts/lcax.schema.json', label: 'LCAx JSON Schema' }
40-
# - { path: 'packages/python/src/lcax/pydantic.py', label: 'LCAx Python Classes' }
41-
# - { path: 'artifacts/lcax.d.ts', label: 'LCAx TypeScript Declarations' }
42-
- { path: 'artifacts/project.rs', label: 'LCAx Rust Structs' }
43-
# - { path: 'artifacts/lcax.cs', label: 'LCAx C# Classes' }
40+
- { path: 'artifacts/validation.schema.json', label: 'LCAx Validation Schema' }
4441
- - "@semantic-release/git"
4542
- assets:
4643
- "CHANGELOG.md"

docs/.gitignore

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

docs/.prettierrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"semi": false,
3+
"tabWidth": 2,
4+
"printWidth": 120,
5+
"singleQuote": true,
6+
"trailingComma": "all",
7+
"jsxSingleQuote": true,
8+
"bracketSpacing": true
9+
}

docs/README.md

Lines changed: 23 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,36 @@
1-
# Starlight Starter Kit: Basics
1+
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3+
## Getting Started
44

5-
```
6-
npm create astro@latest -- --template starlight
7-
```
8-
9-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11-
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
12-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
13-
14-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
5+
First, run the development server:
156

16-
## 🚀 Project Structure
7+
```bash
8+
npm run dev
9+
# or
10+
yarn dev
11+
# or
12+
pnpm dev
13+
# or
14+
bun dev
15+
```
1716

18-
Inside of your Astro + Starlight project, you'll see the following folders and files:
17+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1918

20-
```
21-
.
22-
├── public/
23-
├── src/
24-
│ ├── assets/
25-
│ ├── content/
26-
│ │ ├── docs/
27-
│ │ └── content.config.ts
28-
│ └── env.d.ts
29-
├── astro.config.mjs
30-
├── package.json
31-
└── tsconfig.json
32-
```
19+
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
3320

34-
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
21+
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
3522

36-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
23+
## Learn More
3724

38-
Static assets, like favicons, can be placed in the `public/` directory.
25+
To learn more about Next.js, take a look at the following resources:
3926

40-
## 🧞 Commands
27+
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28+
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
4129

42-
All commands are run from the root of the project, from a terminal:
30+
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
4331

44-
| Command | Action |
45-
| :------------------------ | :----------------------------------------------- |
46-
| `npm install` | Installs dependencies |
47-
| `npm run dev` | Starts local dev server at `localhost:4321` |
48-
| `npm run build` | Build your production site to `./dist/` |
49-
| `npm run preview` | Preview your build locally, before deploying |
50-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
51-
| `npm run astro -- --help` | Get help using the Astro CLI |
32+
## Deploy on Vercel
5233

53-
## 👀 Want to learn more?
34+
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
5435

55-
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
36+
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

docs/astro.config.mjs

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

0 commit comments

Comments
 (0)