From 91795539a720ded802345a56558fc8448a4322dc Mon Sep 17 00:00:00 2001 From: Joanna May Date: Thu, 1 Aug 2024 12:50:20 -0500 Subject: [PATCH] fix: spelling, slow link, formatting --- .github/workflows/spell_check.yml | 2 +- cspell.json | 21 ++++++++----------- src/content/docs/architecture/barrel_files.md | 2 +- src/content/docs/development/conventions.mdx | 4 ++-- src/content/docs/development/philosophy.mdx | 4 ++-- src/content/docs/development/services.mdx | 1 - .../internationalization/localization.mdx | 2 +- src/content/docs/navigation/navigation.mdx | 2 +- 8 files changed, 17 insertions(+), 21 deletions(-) diff --git a/.github/workflows/spell_check.yml b/.github/workflows/spell_check.yml index 61d2a94..ee4a24a 100644 --- a/.github/workflows/spell_check.yml +++ b/.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 diff --git a/cspell.json b/cspell.json index 610ef27..33699d9 100644 --- a/cspell.json +++ b/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" ] } diff --git a/src/content/docs/architecture/barrel_files.md b/src/content/docs/architecture/barrel_files.md index b86fc47..fb7f98e 100644 --- a/src/content/docs/architecture/barrel_files.md +++ b/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 diff --git a/src/content/docs/development/conventions.mdx b/src/content/docs/development/conventions.mdx index 17cd17a..7785b8a 100644 --- a/src/content/docs/development/conventions.mdx +++ b/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. \ No newline at end of file +- ๐Ÿค [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) โ€”ย  code of conduct designed to promote a welcoming and inclusive community. diff --git a/src/content/docs/development/philosophy.mdx b/src/content/docs/development/philosophy.mdx index a29ca66..77a7503 100644 --- a/src/content/docs/development/philosophy.mdx +++ b/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 \ No newline at end of file +[pub.dev]: https://pub.dev diff --git a/src/content/docs/development/services.mdx b/src/content/docs/development/services.mdx index 78075d7..e68fb6e 100644 --- a/src/content/docs/development/services.mdx +++ b/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/ - diff --git a/src/content/docs/internationalization/localization.mdx b/src/content/docs/internationalization/localization.mdx index d7d93f0..eaac9ab 100644 --- a/src/content/docs/internationalization/localization.mdx +++ b/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!" } ``` diff --git a/src/content/docs/navigation/navigation.mdx b/src/content/docs/navigation/navigation.mdx index 9a3b14d..623d08b 100644 --- a/src/content/docs/navigation/navigation.mdx +++ b/src/content/docs/navigation/navigation.mdx @@ -76,6 +76,7 @@ GoRouter allows you to define [type-safe routes](https://pub.dev/documentation/g } } ``` + ```dart @@ -118,7 +119,6 @@ context.go('/categories?size=small&color=blue'); ::: - ### 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.