diff --git a/astro.config.mjs b/astro.config.mjs index 6dbfa00..627847e 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -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: { @@ -71,12 +77,6 @@ export default defineConfig({ directory: "code_style", }, }, - { - label: "🦄 Development", - autogenerate: { - directory: "development", - }, - }, { label: "📺 Examples", badge: "NEW", diff --git a/src/content/docs/very_good_engineering/contributing.mdx b/src/content/docs/very_good_engineering/contributing.mdx new file mode 100644 index 0000000..3ed5aae --- /dev/null +++ b/src/content/docs/very_good_engineering/contributing.mdx @@ -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 diff --git a/src/content/docs/development/conventions.mdx b/src/content/docs/very_good_engineering/conventions.mdx similarity index 100% rename from src/content/docs/development/conventions.mdx rename to src/content/docs/very_good_engineering/conventions.mdx diff --git a/src/content/docs/very_good_engineering/credits.mdx b/src/content/docs/very_good_engineering/credits.mdx new file mode 100644 index 0000000..436bcf5 --- /dev/null +++ b/src/content/docs/very_good_engineering/credits.mdx @@ -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 diff --git a/src/content/docs/development/diagrams/good_code_dark.png b/src/content/docs/very_good_engineering/diagrams/good_code_dark.png similarity index 100% rename from src/content/docs/development/diagrams/good_code_dark.png rename to src/content/docs/very_good_engineering/diagrams/good_code_dark.png diff --git a/src/content/docs/development/diagrams/good_code_light.png b/src/content/docs/very_good_engineering/diagrams/good_code_light.png similarity index 100% rename from src/content/docs/development/diagrams/good_code_light.png rename to src/content/docs/very_good_engineering/diagrams/good_code_light.png diff --git a/src/content/docs/development/philosophy.mdx b/src/content/docs/very_good_engineering/philosophy.mdx similarity index 100% rename from src/content/docs/development/philosophy.mdx rename to src/content/docs/very_good_engineering/philosophy.mdx diff --git a/src/content/docs/development/services.mdx b/src/content/docs/very_good_engineering/services.mdx similarity index 100% rename from src/content/docs/development/services.mdx rename to src/content/docs/very_good_engineering/services.mdx