pr request

.devcontainer/devcontainer.json

@@ -0,0 +1,12 @@
+{
+  "name": "Thoth-Tech Website Dev",
+  "dockerComposeFile": "./docker-compose.yml",
+  "service": "thoth-astro-dev",
+  "workspaceFolder": "/site",
+  "workspaceMount": "source=${localWorkspaceFolder},target=/site,type=bind",
+  "forwardPorts": [4321],
+  "postStartCommand": "npm run dev",
+  "features": {
+    "ghcr.io/devcontainers/features/github-cli:1": {}
+  }
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,15 @@
+services:
+  thoth-astro-dev:
+    build:
+      context: ../
+      dockerfile: Dockerfile
+    ports:
+      - "4321:4321"
+    volumes:
+      - ..:/site
+      - thoth-astro-node_modules:/site/node_modules
+    tty: true
+    stdin_open: true
+    command: sleep infinity
+volumes:
+  thoth-astro-node_modules:

.dockerignore

@@ -0,0 +1,24 @@
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/pull_request_template.md

@@ -22,9 +22,12 @@ reproduce. Please also list any relevant details for your test configuration_
 
 ## Testing Checklist
 
-- [ ] Tested in latest Chrome
-- [ ] Tested in latest Safari
-- [ ] Tested in latest Firefox
+- [ ] Have run `npm run format`
+- [ ] Have run `npm run build`
+- [ ] Have run `npm run dev` and/or `npm run preview`, using:
+  - [ ] Chrome
+  - [ ] Safari
+  - [ ] Firefox
 
 ## Checklist
 

.github/workflows/ci.yml

@@ -3,7 +3,9 @@ name: CI
 on:
   pull_request:
   push:
-    branches: [main]
+    branches:
+    - main
+    - development
 
 jobs:
   build:
@@ -23,7 +25,9 @@ jobs:
         run: npm run format:check
       - name: Vale
         run: |
-          sudo apt update
-          sudo apt install snapd
-          sudo snap install vale --edge
+          curl -L -o vale.tar.gz "https://github.com/errata-ai/vale/releases/download/v3.13.0/vale_3.13.0_Linux_64-bit.tar.gz"
+          tar -xzf vale.tar.gz
+          sudo mv vale /usr/local/bin/vale
+          rm vale.tar.gz
+          vale --version
           npm run prose:check

.linelint.yml

@@ -0,0 +1,19 @@
+# 'true' will fix files
+autofix: false
+
+# list of paths to ignore, uses gitignore syntaxes (executes before any rule)
+ignore:
+  - src/styles/*.css
+  - .lintlint.yml
+
+rules:
+  # checks if file ends in a newline character
+  end-of-file:
+    # set to true to enable this rule
+    enable: true
+
+    # set to true to disable autofix (if enabled globally)
+    disable-autofix: true
+
+    # if true also checks if file ends in a single newline character
+    single-new-line: true

.markdownlint.json

@@ -0,0 +1,9 @@
+{
+  "MD033": false,
+  "MD024": false,
+  "MD013": {
+    "line_length": 100,
+    "code_blocks": false,
+    "tables": false
+  }
+}

.netlify/state.json

@@ -1,3 +1,3 @@
 {
-	"siteId": "5273a592-7468-452e-a000-9f3e699ecc05"
+	"siteId": "b5458139-7fea-4422-a3fe-cd2fc7d3b7bb"
 }

.vale/thothtech/MeaningfulLinkWords.yml

@@ -7,7 +7,7 @@
 extends: existence
 message: 'Improve SEO and accessibility by rewriting "%s" in the link text.'
 level: warning
-scope: link
+scope: raw
 ignorecase: true
 link: TBA
 tokens:

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+    "configurations": [
+        {
+            "name": "Docker Node.js Launch",
+            "type": "docker",
+            "request": "launch",
+            "preLaunchTask": "docker-run: debug",
+            "platform": "node"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "files.associations": {
+    "*.mdx": "markdown"
+  },
+  "json.format.keepLines": true
+}

CONTRIBUTING.md

@@ -94,7 +94,7 @@ syllables per word. For more information, see
    [official instructions to install nvm](https://github.com/nvm-sh/nvm#installing-and-updating), a
    Node version manager. Then, run the following to install and use the repository's Node version:
 
-   ```sh
+   ```shell
    nvm install
    nvm use
    ```
@@ -103,7 +103,8 @@ syllables per word. For more information, see
    confirmed by running `nvm which`.
 
 1. Install all dependencies
-   ```sh
+
+   ```shell
    npm install
    ```
 
@@ -123,15 +124,15 @@ syllables per word. For more information, see
 
 1. Install curl
 
-   ```sh
+   ```shell
    sudo apt-get install curl
    ```
 
 1. Follow the
    [official instructions to install nvm](https://github.com/nvm-sh/nvm#installing-and-updating), a
    Node version manager. Then, run the following to install and use the repository's Node version:
 
-   ```sh
+   ```shell
    nvm install
    nvm use
    ```
@@ -140,7 +141,8 @@ syllables per word. For more information, see
    confirmed by running `nvm which`.
 
 1. Install all dependencies
-   ```sh
+
+   ```shell
    npm install
    ```
 
@@ -153,7 +155,6 @@ syllables per word. For more information, see
    ```
 
 1. Install [`vale`](https://github.com/errata-ai/vale/releases). To install for:
-
    - macOS using `brew`, run: `brew install vale`.
    - Linux, use your distribution's package manager or a
      [released binary](https://github.com/errata-ai/vale/releases).

Dockerfile

@@ -0,0 +1,23 @@
+FROM node:iron-trixie-slim
+
+WORKDIR /site
+
+COPY package*.json /site/
+
+RUN apt-get update && apt-get upgrade -y
+RUN apt-get install git curl -y
+
+RUN npm install
+
+# Install Vale
+RUN curl -L -o vale.tar.gz "https://github.com/errata-ai/vale/releases/download/v3.13.0/vale_3.13.0_Linux_64-bit.tar.gz" \
+  && tar -xzf vale.tar.gz \
+  && mv vale /usr/local/bin/vale \
+  && rm vale.tar.gz \
+  && vale --version
+
+ENV HOST=0.0.0.0
+ENV PORT=4321
+
+# Expose the dev server port
+EXPOSE 4321

README.md

@@ -1,54 +1,110 @@
-# Starlight Starter Kit: Basics
+# ThothTech Documentation Website
 
-```
-npm create astro@latest -- --template starlight
-```
+<p align="left">
+    <img width="150px" src="https://github.com/thoth-tech/.github/blob/main/images/splashkit.png"
+    alt="Thoth Tech Logo"/>
+</p>
 
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
+[![GitHub contributors](https://img.shields.io/github/contributors/thoth-tech/ThothTech-Documentation-Website?label=Contributors&color=F5A623)](https://github.com/thoth-tech/ThothTech-Documentation-Website/graphs/contributors)
+[![GitHub issues](https://img.shields.io/github/issues/thoth-tech/ThothTech-Documentation-Website?label=Issues&color=F5A623)](https://github.com/thoth-tech/ThothTech-Documentation-Website/issues)
+[![GitHub pull requests](https://img.shields.io/github/issues-pr/thoth-tech/ThothTech-Documentation-Website?label=Pull%20Requests&color=F5A623)](https://github.com/thoth-tech/ThothTech-Documentation-Website/pulls)
+[![Forks](https://img.shields.io/github/forks/thoth-tech/ThothTech-Documentation-Website?label=Forks&color=F5A623)](https://github.com/thoth-tech/ThothTech-Documentation-Website/network/members)
+[![Stars](https://img.shields.io/github/stars/thoth-tech/ThothTech-Documentation-Website?label=Stars&color=F5A623)](https://github.com/thoth-tech/ThothTech-Documentation-Website/stargazers)
 
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+Welcome to the **ThothTech Documentation Website** repository! This project serves as the central
+hub for all Thoth Tech resources, designed to provide a structured and accessible platform for
+documentation, product information, and team resources. This contains out long term documentation,
+such as the documentation for onboarding information, general information and company deliverables.
 
-## 🚀 Project Structure
+Short term documentation such as spike reports and sprint reports are stored in the
+[Documentation](https://github.com/thoth-tech/documentation) repository.
 
-Inside of your Astro + Starlight project, you'll see the following folders and files:
+Built with Astro and Starlight, this website offers an organized space where users can explore Thoth
+Tech's mission, values, and goals, along with in-depth information on each of the company's products
+and services. Each product has its own dedicated section, featuring a brief overview, its purpose,
+and comprehensive documentation to support both users and development teams.
 
-```
+The site also includes team documentation for each semester, highlighting the efforts of the
+individuals contributing to Thoth Tech's ongoing projects. Whether you're a developer, a team
+member, or a user, this website provides all the information needed to understand and contribute to
+Thoth Tech's vision and initiatives.
+
+## Format Checks to Run
+
+To maintain code quality, please ensure you run the following commands before submitting a pull
+request:
+
+1. **Format the Files**:
+
+   ```shell
+   npm run format
+   ```
+
+2. **Run the Lint Checker**:
+
+   ```shell
+   npm run lint
+   ```
+
+3. **Build the website (and check links are valid)**:
+
+   ```shell
+   npm run build
+   ```
+
+## Project Structure
+
+This website is built with Astro and uses the **Starlight Starter Kit** as a foundation. Below is a
+breakdown of the project structure:
+
+```plaintext
 .
-├── public/
+├── public/              # Static assets like favicons, images
 ├── src/
-│   ├── assets/
-│   ├── content/
-│   │   ├── docs/
-│   │   └── config.ts
-│   └── env.d.ts
-├── astro.config.mjs
-├── package.json
-└── tsconfig.json
+│   ├── content/         # Markdown files for documentation content
+│   │   ├── docs/        # Documentation pages
+│   │   └── config.ts    # Configuration for Starlight content
+│   ├── styles/          # Custom CSS for styling
+│   └── env.d.ts         # TypeScript environment definitions
+├── astro.config.mjs     # Astro configuration
+├── package.json         # Node.js dependencies and scripts
+└── tsconfig.json        # TypeScript configuration
 ```
 
-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.
+- **Documentation Content**: `.md` or `.mdx` files placed in `src/content/docs/` are exposed as
+  routes based on their filenames.
+- **Static Assets**: Place images and other static files in `public/` for easy access.
+
+## Commands
 
-Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+All commands should be run from the root of the project in the terminal:
 
-Static assets, like favicons, can be placed in the `public/` directory.
+| Command                   | Action                                                  |
+| :------------------------ | :------------------------------------------------------ |
+| `npm install`             | Installs all dependencies                               |
+| `npm run dev`             | Starts the local development server at `localhost:4321` |
+| `npm run build`           | Builds the production-ready site in `./dist/`           |
+| `npm run preview`         | Previews your build locally before deployment           |
+| `npm run astro ...`       | Runs Astro CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Displays help for Astro CLI commands                    |
 
-## 🧞 Commands
+---
+
+## Getting Started
+
+To initialize the project, use the following Astro command to set up with the Starlight Starter Kit:
+
+```shell
+npm create astro@latest -- --template starlight
+```
 
-All commands are run from the root of the project, from a terminal:
+For more information, check out the [CONTRIBUTING.md](CONTRIBUTING.md) file.
 
-| Command                   | Action                                           |
-| :------------------------ | :----------------------------------------------- |
-| `npm install`             | Installs dependencies                            |
-| `npm run dev`             | Starts local dev server at `localhost:3000`      |
-| `npm run build`           | Build your production site to `./dist/`          |
-| `npm run preview`         | Preview your build locally, before deploying     |
-| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro -- --help` | Get help using the Astro CLI                     |
+## Learn More
 
-## 👀 Want to learn more?
+For additional resources, check out the following:
 
-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).
+- **[Starlight Documentation](https://starlight.astro.build/)**: Learn more about the Starlight
+  Starter Kit.
+- **[Astro Documentation](https://docs.astro.build)**: Understand the Astro framework.
+- **[Astro Discord Server](https://astro.build/chat)**: Connect with the Astro community.