Skip to content

Commit 1d8984e

Browse files
docs(site): inconsistency fixes (#1495)
* docs(site): inconsistency fixes * chore: run prettier
1 parent 70661c9 commit 1d8984e

File tree

10 files changed

+17
-39
lines changed

10 files changed

+17
-39
lines changed

site/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 📚 Very Good ClI Docs
1+
# 📚 Very Good CLI Docs
22

33
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
44

@@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv
2929
Using SSH:
3030

3131
```
32-
$ USE_SSH=true yarn deploy
32+
$ USE_SSH=true npm run deploy
3333
```
3434

3535
Not using SSH:
3636

3737
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
38+
$ GIT_USER=<Your GitHub username> npm run deploy
3939
```
4040

4141
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

site/docs/commands/check_licenses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The `allowed` and `forbidden` options can't be used at the same time. Typical or
5656

5757
### `dependency-type`
5858

59-
The type of dependencies to check licenses for. There are three available types:
59+
The type of dependencies to check licenses for. There are four available types:
6060

6161
- [`direct-dev`](https://dart.dev/tools/pub/dependencies#dev-dependencies): Another package that your package needs during development.
6262
- [`direct-main`](https://dart.dev/tools/pub/dependencies): Another package that your package needs to work.

site/docs/commands/test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For example, if you wish to run `flutter test --no-track-widget-creation` you ca
5757

5858
### Tests without pub install
5959

60-
Unlike `dart test` or `flutter test`, `very_good test` will always run your tests without installing the projects dependencies (i.e. `--no-pub` flag).
60+
Unlike `dart test` or `flutter test`, `very_good test` will always run your tests without installing the project's dependencies (i.e. `--no-pub` flag).
6161

6262
This is an optimization done by the CLI because dependency installation is usually run once after cloning the repository. Conversely, running tests locally is usually done many times and it's often unnecessary to re-install dependencies prior to each test run.
6363

site/docs/overview.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,5 +182,4 @@ Run "very_good help <command>" for more information about a command.
182182
[dart_sdk]: https://dart.dev/get-dart
183183
[flutter_sdk]: https://docs.flutter.dev/get-started/install
184184
[very_good_cli]: https://raw.githubusercontent.com/VeryGoodOpenSource/very_good_cli/main/doc/assets/very_good_create.gif
185-
[new_syntax_link]: /docs/resources/syntax_changes_in_0_10_0
186185
[path_setup_link]: https://dart.dev/tools/pub/cmd/pub-global#running-a-script-from-your-path

site/docs/resources/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Resources",
3-
"position": 4,
3+
"position": 5,
44
"link": {
55
"title": "Resources",
66
"type": "generated-index",

site/docs/resources/syntax_changes_in_0_10_0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 3
66

77
The syntax of the `very_good create` command changed in v0.10.0.
88

9-
Previously, the `very_good_cli` would receive the template type via a `-t` flag. Now,`very_good_cli` receives sub-commands for each template. This makes it easier for us to support multiple templates and streamlines the command step for users.
9+
Previously, the `very_good_cli` would receive the template type via a `-t` flag. Now, `very_good_cli` receives sub-commands for each template. This makes it easier for us to support multiple templates and streamlines the command step for users.
1010

1111
Refer to the following examples to better understand the syntax changes:
1212

site/docs/templates/core.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,15 @@ We liked the [starter app][counter_app_link] provided by the `flutter create` co
1414

1515
## App Features ✨
1616

17-
- **Multi-Platform Support** - Support for iOS, Android, Web, and Windows (macOS and Linux coming soon!)
17+
- **Multi-Platform Support** - Support for iOS, Android, Web, Windows, macOS, and Linux
1818

1919
- **Build Flavors** - Multiple flavor support for development, staging, and production
2020

2121
- **Internationalization Support** - Internationalization support using synthetic code generation to streamline the development process
2222

23-
- **Sound Null Safety** - No more null-dereference exceptions at runtime. Develop with a sound, static type system.
24-
2523
- **[Bloc][bloc_pub]** - Layered architecture with `bloc` for scalable, testable code which offers a clear separation between business logic and presentation
2624

27-
- **Testing** - Unit and widget tests with 100% line coverage (integration tests coming soon!)
25+
- **Testing** - Unit and widget tests with 100% line coverage
2826

2927
- **Logging** - Extensible logging to capture uncaught Dart and Flutter exceptions
3028

@@ -48,7 +46,7 @@ dart pub global activate very_good_cli
4846

4947
### Create a new Flutter Project 🆕
5048

51-
Then, you can use the `very_good create flutter_app` command just like you would `flutter create`. If desired, can specify a custom org name at time of generation with the `--org` flag.
49+
Then, you can use the `very_good create flutter_app` command just like you would `flutter create`. If desired, you can specify a custom org name at time of generation with the `--org` flag.
5250

5351
:::tip
5452
Use `-o` or `--output-directory` to specify a custom output directory for the generated project.
@@ -70,11 +68,11 @@ very_good create flutter_app . --desc "My new Flutter app"
7068

7169
### Running the Project ⚡
7270

73-
Once you have finished running `very_good create` with the project directory of your choice, you can change directories into the new project directory and install the dependencies
71+
Once you have finished running `very_good create` with the project directory of your choice, you can change directories into the new project directory and install the dependencies.
7472

7573
```sh
7674
cd my_app
77-
flutter packages get
75+
flutter pub get
7876
```
7977

8078
This project contains 3 flavors:

site/docs/templates/flame_game.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,9 @@ very_good create flame_game my_game --desc "My new Flame game"
4545
# Create a new Flame game named with the name of the current directory
4646
very_good create flame_game . --desc "My new Flame game"
4747

48-
# Create a new Flutter plugin named my_flutter_plugin (supports only android and iOS)
48+
# Create a new Flame game named my_game (supports only android and iOS)
4949
very_good create flame_game my_game --platforms android,ios
5050
```
5151

5252
[blog]: https://verygood.ventures/blog/generate-a-game-with-our-new-template
53-
[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli
54-
[mason_link]: https://github.com/felangel/mason
5553
[flame_link]: https://flame-engine.org/

site/docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ const config = {
2222
projectName: 'very_good_cli',
2323
trailingSlash: false,
2424

25-
// Even if you don't use internalization, you can use this field to set useful
25+
// Even if you don't use internationalization, you can use this field to set useful
2626
// metadata like html lang. For example, if your site is Chinese, you may want
2727
// to replace "en" with "zh-Hans".
2828
i18n: {

site/src/pages/index.tsx

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ function HomepageHeader() {
1515
<div className="container">
1616
<img
1717
className={clsx(styles.heroLogo)}
18-
src={colorMode == 'dark' ? 'img/logo_dark.svg' : 'img/logo.svg'}
18+
src={colorMode === 'dark' ? 'img/logo_dark.svg' : 'img/logo.svg'}
1919
alt="CLI Logo"
2020
/>
2121
<p className="hero__subtitle">{siteConfig.tagline}</p>
@@ -30,7 +30,7 @@ export default function Home(): React.JSX.Element {
3030
const { siteConfig } = useDocusaurusContext();
3131
return (
3232
<Layout
33-
description={`The official documentation site for Very Good CLI Docs. ${siteConfig.tagline}.`}
33+
description={`The official documentation site for Very Good CLI. ${siteConfig.tagline}.`}
3434
>
3535
<HomepageHeader />
3636
<main>
@@ -99,7 +99,7 @@ const FeatureList: FeatureItem[] = [
9999
description: (
100100
<>
101101
Optimize your tests and recursively fetch packages with additional CLI{' '}
102-
<a href="/docs/category/commands"> commands</a>.
102+
<a href="/docs/category/commands">commands</a>.
103103
</>
104104
),
105105
},
@@ -193,20 +193,3 @@ function HomepageBlogs() {
193193
</div>
194194
);
195195
}
196-
197-
function ExternalLinkIcon() {
198-
return (
199-
<svg
200-
width="13.5"
201-
height="13.5"
202-
aria-hidden="true"
203-
viewBox="0 0 24 24"
204-
className="iconExternalLink_node_modules-@docusaurus-theme-classic-lib-theme-IconExternalLink-styles-module"
205-
>
206-
<path
207-
fill="currentColor"
208-
d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"
209-
></path>
210-
</svg>
211-
);
212-
}

0 commit comments

Comments
 (0)