Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve grammar #168

Merged
merged 3 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/architecture-concepts/application-lifecycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Some other operation will be done when loading the foundation, such as:
:::note

The process of loading the Athenna foundation is triggered by the
`Ignite.load` method.
`Ignite.load()` method.

:::

Expand Down 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
2 changes: 1 addition & 1 deletion docs/architecture-concepts/service-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ The following environments are available by default in Athenna at this moment:
- console

You could also create your own environments. In your `Path.bootstrap('main.ts')` file
you can add an `environments` option when calling `Ignite.load` method:
you can add an `environments` option when calling `Ignite.load()` method:

```typescript
import { Ignite } from '@athenna/core'
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
2 changes: 1 addition & 1 deletion docs/testing/mocking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1121,6 +1121,6 @@ export default class UserServiceTest {
Mocking the methods of the `Database.driver` property gaves you
power to change the behavior of models and also `Database`
facade calls. You are able to mock any method of the
database [query builder](/docs/database/query-builder)
database [query builder.](/docs/database/query-builder)

:::
Loading