Skip to content

Commit

Permalink
fix: spelling, slow link, formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jolexxa committed Aug 1, 2024
1 parent b7783fa commit 9179553
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/spell_check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 9 additions & 12 deletions cspell.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -26,6 +17,12 @@
"tailwindcss",
"Tappable",
"todos",
"tsconfigs"
"tsconfigs",
"Codemagic",
"Diátaxis",
"Ishida",
"Hola",
"Mundo",
"merch"
]
}
2 changes: 1 addition & 1 deletion src/content/docs/architecture/barrel_files.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions src/content/docs/development/conventions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions src/content/docs/development/philosophy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
1 change: 0 additions & 1 deletion src/content/docs/development/services.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/

2 changes: 1 addition & 1 deletion src/content/docs/internationalization/localization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Check out the [documentation][l10n_file_documentation] regarding the configurati

```json
{
"helloWorld": "Hello World!",
"helloWorld": "Hello World!"
}
```

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/navigation/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ GoRouter allows you to define [type-safe routes](https://pub.dev/documentation/g
}
}
```

</TabItem>
<TabItem label="Bad ❗️">
```dart
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 9179553

Please sign in to comment.