Merge pull request #40 from VGVentures/chore/rename

chore: rename project

.github/workflows/spell_check.yml

@@ -8,7 +8,7 @@ jobs:
     with:
       config: cspell.json
       includes: |
-        **/*.{dart,md,mdxyaml,ts,tsx,js,jsx,json,yaml,yml}
+        **/*.{dart,md,mdx,yaml,ts,tsx,js,jsx,json,yaml,yml}
         !.dart_tool/**/*.{dart,yaml}
         !node_modules/**/*
         .*/**/*.yml

README.md

@@ -1,4 +1,4 @@
-# Very Good Practices Site
+# Very Good Engineering Site
 
 [![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
 

astro.config.mjs

@@ -11,7 +11,7 @@ export default defineConfig({
   integrations: [
     starlight({
       favicon: "./public/favicon.png",
-      title: "Very Good Practices",
+      title: "Very Good Engineering",
       head: [
         {
           // Fix theme flickering on page load.
@@ -42,14 +42,14 @@ export default defineConfig({
       ],
       editLink: {
         baseUrl:
-          "https://github.com/verygoodopensource/very_good_practices/edit/main/docs/",
+          "https://github.com/vgventures/very_good_engineering/edit/main/docs/",
       },
       logo: {
         light: "./src/assets/logos/unicorn_light.png",
         dark: "./src/assets/logos/unicorn_dark.png",
       },
       social: {
-        github: "https://github.com/verygoodopensource/very_good_practices",
+        github: "https://github.com/vgventures/very_good_engineering",
       },
       sidebar: [
         {
@@ -63,7 +63,8 @@ export default defineConfig({
           autogenerate: {
             directory: "automation",
           },
-        }, {
+        },
+        {
           label: "Code Style",
           autogenerate: {
             directory: "code_style",
@@ -80,7 +81,8 @@ export default defineConfig({
           autogenerate: {
             directory: "internationalization",
           },
-        }, {
+        },
+        {
           label: "Navigation",
           autogenerate: {
             directory: "navigation",

cspell.json

@@ -1,17 +1,8 @@
 {
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "ignorePaths": [
-    "node_modules/**",
-    ".**/"
-  ],
-  "files": [
-    "**/*.md",
-    "**/*.mdx",
-    "**/*.tsx",
-    "**/*.ts",
-    "**/*.json"
-  ],
+  "ignorePaths": ["node_modules/**", ".**/"],
+  "files": ["**/*.md", "**/*.mdx", "**/*.tsx", "**/*.ts", "**/*.json"],
   "words": [
     "astro",
     "astrojs",
@@ -26,6 +17,12 @@
     "tailwindcss",
     "Tappable",
     "todos",
-    "tsconfigs"
+    "tsconfigs",
+    "Codemagic",
+    "Diátaxis",
+    "Ishida",
+    "Hola",
+    "Mundo",
+    "merch"
   ]
 }

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "very-good-practices-site",
+  "name": "very-good-engineering",
   "type": "module",
   "version": "0.0.1",
   "scripts": {

src/content/docs/architecture/barrel_files.md

@@ -133,4 +133,4 @@ When working with barrel files, it might be a bit tedious to export every file m
 :::
 
 [bloc_documentation]: https://bloclibrary.dev/#/flutterlogintutorial?id=authentication-bloc
-[vscode_extension]: https://marketplace.visualstudio.com/items?itemName=orestesgaolin.dart-export-index
+[vscode_extension]: https://github.com/orestesgaolin/dart-export-index

src/content/docs/development/conventions.mdx

@@ -9,7 +9,7 @@ There are a handful of external development standards and conventions that we en
 
 - 📄 [Diátaxis](https://diataxis.fr/) — a systematic approach to technical documentation authoring.
 - 🎎 [Semantic Versioning](https://semver.org/) — a versioning scheme for software.
-- 💠 [Conventional Commmits](https://www.conventionalcommits.org/en/v1.0.0/) — a specification for adding human and machine readable meaning to commit messages.
+- 💠 [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) — a specification for adding human and machine readable meaning to commit messages.
 - 🪵 [Keep a Changelog](https://keepachangelog.com/) — a specification for maintaining a changelog.
 - 🧊 [Opinionated "Recommended" Practices for flutter_bloc](https://github.com/chonghorizons/flutter_bloc_opinionated_practices/wiki/Opinionated-%22Recommended%22-Practices-for-flutter_bloc)
-- 🤝 [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) —  code of conduct designed to promote a welcoming and inclusive community.
+- 🤝 [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) —  code of conduct designed to promote a welcoming and inclusive community.

src/content/docs/development/philosophy.mdx

@@ -138,7 +138,7 @@ Businesses rapidly change product requirements to meet demand or remain competit
 
 ## 🤓 Approachability
 
-As always, there are trade-offs to every approach. Our approach to state managment requires a certain amount of boilerplate, but we find the additional rigor allows us to easily understand what's going on, making it easy to refactor quickly.
+As always, there are trade-offs to every approach. Our approach to state management requires a certain amount of boilerplate, but we find the additional rigor allows us to easily understand what's going on, making it easy to refactor quickly.
 
 ## 🏎️ Performance
 
@@ -167,4 +167,4 @@ As a team, we have many cumulative years of experience with apps of all kinds, f
 [declarative]: https://stackoverflow.com/a/15382180
 [time-complexity]: https://en.wikipedia.org/wiki/Time_complexity
 [very-good-layered-architecture]: https://verygood.ventures/blog/very-good-flutter-architecture
-[pub.dev]: https://pub.dev
+[pub.dev]: https://pub.dev

src/content/docs/development/services.mdx

@@ -26,4 +26,3 @@ Besides integrating in-house enterprise solutions, we've had positive experience
 [Codemagic]: https://codemagic.io/
 [Rive]: https://rive.app/
 [RevenueCat]: https://www.revenuecat.com/
-

src/content/docs/index.mdx

@@ -1,5 +1,5 @@
 ---
-title: Very Good Practices
+title: Very Good Engineering
 description: Get started building your docs site with Starlight.
 template: splash
 hero:

src/content/docs/internationalization/localization.mdx

@@ -54,7 +54,7 @@ Check out the [documentation][l10n_file_documentation] regarding the configurati
 
 ```json
 {
-  "helloWorld": "Hello World!",
+  "helloWorld": "Hello World!"
 }
 ```
 

src/content/docs/navigation/navigation.mdx

@@ -76,6 +76,7 @@ GoRouter allows you to define [type-safe routes](https://pub.dev/documentation/g
       }
     }
     ```
+
   </TabItem>
   <TabItem label="Bad ❗️">
     ```dart
@@ -118,7 +119,6 @@ context.go('/categories?size=small&color=blue');
 </Tabs>
 :::
 
-
 ### Prefer `go` over `push` methods
 
 GoRouter offers multiple ways to navigate to a route, such as pushing every route onto the stack and navigating to a route's path.