Skip to content

Commit

Permalink
feat(docs): improve grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
jlenon7 committed Jan 11, 2024
1 parent 85c853d commit 11fc40d
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 11 deletions.
4 changes: 3 additions & 1 deletion docs/architecture-concepts/application-lifecycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,9 @@ const ignite = await new Ignite().load(import.meta.url, {
bootLogs: false
})

await ignite.console({ kernelPath: '#app/http/CustomKernel' })
await ignite.console(process.argv, {
kernelPath: '#app/http/CustomKernel'
})
```

### Execution
Expand Down
19 changes: 10 additions & 9 deletions docs/cli-application/running.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@ Check how to run your CLI commands in different scenarios.

## Introduction

The CLI application of Athenna can run in three ways.
Using the `node artisan`, the npm scripts inside
`package.json` file or linking the CLI using `npm link`,
this way you can execute your CLI anywhere from your
terminal. As Artisan and npm scripts comes configured by
default in your application, we are going to focus in
`npm link` in this documentation.
To run the CLI application you have two options:

1. Run using the `node artisan`.
2. Link your CLI using `npm link` command and run it anywhere.

As running with `node artisan` is simple and has a lot of examples
over Athenna documentation, we are going to focus in linking your
CLI to run anywhere of your terminal.

## Registering your CLI command name

Expand Down Expand Up @@ -70,7 +71,7 @@ import { Ignite } from '@athenna/core'

const ignite = await new Ignite().load(import.meta.url)

await ignite.console({
await ignite.console(process.argv, {
displayName: 'Your CLI Command', 👈
})
```
Expand All @@ -85,7 +86,7 @@ import { Ignite } from '@athenna/core'

const ignite = await new Ignite().load(import.meta.url)

await ignite.console({
await ignite.console(process.argv, {
displayName: null, 👈
})
```
Expand Down
2 changes: 1 addition & 1 deletion docs/database/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ your project:
- Add all database commands in your `.athennarc.json` file.
- Add all database template files in your `.athennarc.json` file.
- Add database environment variables to `.env`, `.env.test` and `.env.example`.
- Configure the service `docker-compose.yml` file acordding to the databas selected.
- Configure the `docker-compose.yml` file acordding to the database selected.

## Configuration

Expand Down

0 comments on commit 11fc40d

Please sign in to comment.