Skip to content

Docs for main branch - #4

Merged
arhimede merged 10 commits into
dotkernel:mainfrom
Howriq:main
Nov 21, 2025
Merged

Docs for main branch#4
arhimede merged 10 commits into
dotkernel:mainfrom
Howriq:main

Conversation

@Howriq

Copy link
Copy Markdown
Member

No description provided.

Signed-off-by: Howriq <horea@rospace.com>
Signed-off-by: Howriq <horea@rospace.com>
Signed-off-by: Howriq <horea@rospace.com>

@alexmerlinalexmerlin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arhimede
Did we decide to replace code snippets with screenshots?

Comment threadmkdocs.yml
Comment threadmkdocs.yml Outdated
@@ -13,4 +13,4 @@ site_name: 101.dotkernel
site_description: "Beginner tutorial for using Dotkernel"
repo_url: "https://github.com/dotkernel/tutorial-101#"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
repo_url: "https://github.com/dotkernel/tutorial-101#"
repo_url: "https://github.com/dotkernel/tutorial-101"


steps:
- name: Checkout
uses: actions/checkout@v4

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
uses: actions/checkout@v4
uses: actions/checkout@v5

Comment threaddocs/book/chapter-1.md Outdated
@@ -4,19 +4,7 @@

The first step is to add alongside your current packages the required entries for our Doctrine installation. We would add the following to our `composer.json` file located in our root folder:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The first step is to add alongside your current packages the required entries for our Doctrine installation. We would add the following to our `composer.json` file located in our root folder:
The first step is to add alongside your current packages the required entries for our Doctrine installation.
We would add the following to our `composer.json` file located in our root folder:

Comment threaddocs/book/v1/images/config-provider-2.png
Comment threaddocs/book/chapter-1.md Outdated
```
![bin/doctrine](../images/doctrine.png)

(Optional) To keep things tidy we recommend to make an executable for the migrations of Doctrine as well for example `/bin/doctrine-migrations`:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
(Optional) To keep things tidy we recommend to make an executable for the migrations of Doctrine as well for example `/bin/doctrine-migrations`:
(Optional) To keep things tidy, we recommend making an executable for the migrations of Doctrine as well.
For this, we create `doctrine-migrations` file inside the application's `bin` directory:

Same reason as with the above rephrasing.

Comment threaddocs/book/v1/chapter-1.md
Comment threaddocs/images/composer.png Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why add mezzio/mezzio-twigrenderer and vincentlanglet/twig-cs-fixer when they already are in Light?

Also, I would add phpstan/phpstan-doctrine later, in a different chapter.

Comment threaddocs/book/chapter-1.md Outdated
## Running doctrine

Now that everything has been configured we only need to do one last thing, to create an executable for the Doctrine CLI.
In our case we will create it as `/bin/doctrine`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In our case we will create it as `/bin/doctrine`
In our case we will create a `doctrine` file inside the application's `bin` directory:

Rephrased to avoid confusion with the OS's bin directory - especially since you started the path with a leading /.
If you have a better rephrasing, go with it - as long as it clearly states which bin directory you are referring to.

Signed-off-by: Howriq <horea@rospace.com>
Signed-off-by: Howriq <horea@rospace.com>
Signed-off-by: Howriq <horea@rospace.com>
Comment threaddocs/book/v1/index.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The index.md file goes under docs/book.
See https://github.com/dotkernel/api-documentation/tree/main/docs/book

Signed-off-by: Howriq <horea@rospace.com>
Signed-off-by: Howriq <horea@rospace.com>
Signed-off-by: Howriq <horea@rospace.com>
@arhimede
arhimede merged commit e7191d1 into dotkernel:mainNov 21, 2025
15 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Howriq@alexmerlin@arhimede