Skip to content

Commit

Permalink
feat: very good engineering section, credits, contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
jolexxa committed Aug 29, 2024
1 parent 7d5d4a4 commit 2c6f395
Show file tree
Hide file tree
Showing 8 changed files with 72 additions and 6 deletions.
12 changes: 6 additions & 6 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ export default defineConfig({
github: "https://github.com/vgventures/very_good_engineering",
},
sidebar: [
{
label: "🦄 Very Good Engineering",
autogenerate: {
directory: "very_good_engineering",
},
},
{
label: "🏛️ Architecture",
autogenerate: {
Expand All @@ -71,12 +77,6 @@ export default defineConfig({
directory: "code_style",
},
},
{
label: "🦄 Development",
autogenerate: {
directory: "development",
},
},
{
label: "📺 Examples",
badge: "NEW",
Expand Down
41 changes: 41 additions & 0 deletions src/content/docs/very_good_engineering/contributing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Contributing
description: Very Good Engineering contribution guide.
---

## Setup

We welcome (and encourage) contributions to Very Good Engineering!

Since this is an [Astro] static website with the [Starlight] theme, you'll need to make sure you've installed [NVM] and the latest stable version of [Node.js].

### GitHub PAT

At build time, we dynamically fetch information about GitHub repositories so our cards on the home page are rendered with up-to-date information about the repositories they are linking to. To avoid being throttled by GitHub on rebuilds, you may wish to [create a GitHub PAT][github-pat] with permission to read public repositories and add it to your environment variable in your `.zshrc` or `.bashrc` file:

```
export VGVENTURES_GITHUB_PAT="(your github pat string)"
```

## Contributions

Once you've made changes, you'll want to lint and format your code before submitting a pull request:

```bash title="Terminal"
npm run lint
npm run format
```

:::note
For substantial content changes or additions, we encourage you to first file an [issue] or raise a [discussion] so that we can consider the proposed changes.

For small grammatical or typographical errors, feel free to submit a pull request directly.
:::

[Astro]: https://astro.build/
[Starlight]: https://starlight.astro.build/
[NVM]: https://github.com/nvm-sh/nvm
[Node.js]: https://nodejs.org/
[issue]: https://github.com/VGVentures/very_good_engineering/issues
[discussion]: https://github.com/VGVentures/very_good_engineering/discussions
[github-pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token
25 changes: 25 additions & 0 deletions src/content/docs/very_good_engineering/credits.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Credits
description: Very Good Engineering credits and attributions.
---

Made possible by the following open source projects:

- [Astro]
- [Starlight]
- [NVM]
- [Node.js]

Our landing page graphic combines several wonderful, free assets:

- [Smartphone]
- [Laptop]
- [Unicorn]

[Astro]: https://astro.build/
[Starlight]: https://starlight.astro.build/
[NVM]: https://github.com/nvm-sh/nvm
[Node.js]: https://nodejs.org/
[Smartphone]: https://sketchfab.com/3d-models/smartphone-793ce4333ddb4cb8ab30c6b1da96df81
[Laptop]: https://sketchfab.com/3d-models/laptop-7d870e900889481395b4a575b9fa8c3e
[Unicorn]: https://sketchfab.com/3d-models/just-a-unicorn-8d0ae2d4b1ac4d1f8ab2adcdcc01cc8f
File renamed without changes.
File renamed without changes.

0 comments on commit 2c6f395

Please sign in to comment.