diff --git a/.bots/instructions.md b/.bots/instructions.md new file mode 100644 index 0000000..0467af9 --- /dev/null +++ b/.bots/instructions.md @@ -0,0 +1,5 @@ +- Make sure that the pull request title follows the conventional commit style. + - Alert the developer if the title is in the wrong format. + - Example of a correct title: `fix: some bug`. + - Example of an incorrect title: `Resolves "#18 - some bug"`. + - The scope portion is NOT required in the PR title. diff --git a/README.md b/README.md index 1b7f5c3..a7edf13 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,3 @@ -# Starlight Starter Kit: Basics +# MRS Developer Home Page -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) - -``` -npm create astro@latest -- --template starlight -``` - -> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun! - -## πŸš€ Project Structure - -Inside of your Astro + Starlight project, you'll see the following folders and files: - -``` -. -β”œβ”€β”€ public/ -β”œβ”€β”€ src/ -β”‚ β”œβ”€β”€ assets/ -β”‚ β”œβ”€β”€ content/ -β”‚ β”‚ └── docs/ -β”‚ └── content.config.ts -β”œβ”€β”€ astro.config.mjs -β”œβ”€β”€ package.json -└── tsconfig.json -``` - -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. - -Images can be added to `src/assets/` and embedded in Markdown with a relative link. - -Static assets, like favicons, can be placed in the `public/` directory. - -## 🧞 Commands - -All commands are run from the root of the project, from a terminal: - -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `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 | - -## πŸ‘€ Want to learn more? - -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). +The site is available [here](https://mrs-electronics.dev). diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index c079c42..dc9f98d 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -18,13 +18,14 @@ import { Card, CardGrid, LinkCard } from '@astrojs/starlight/components'; - + + - +