Docs for main branch#4
Merged
arhimede merged 10 commits intodotkernel:mainfrom Nov 21, 2025
Merged
Conversation
Signed-off-by: Howriq <horea@rospace.com>
Signed-off-by: Howriq <horea@rospace.com>
Signed-off-by: Howriq <horea@rospace.com>
alexmerlin
requested changes
Nov 20, 2025
Member
alexmerlin
left a comment
alexmerlin
left a comment
There was a problem hiding this comment.
@arhimede
Did we decide to replace code snippets with screenshots?
| @@ -13,4 +13,4 @@ site_name: 101.dotkernel | |||
| site_description: "Beginner tutorial for using Dotkernel" | |||
| repo_url: "https://github.com/dotkernel/tutorial-101#" | |||
Member
There was a problem hiding this comment.
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 |
Member
There was a problem hiding this comment.
Suggested change
| uses: actions/checkout@v4 | |
| uses: actions/checkout@v5 |
| @@ -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: | |||
Member
There was a problem hiding this comment.
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: |
| ``` | ||
|  | ||
|
|
||
| (Optional) To keep things tidy we recommend to make an executable for the migrations of Doctrine as well for example `/bin/doctrine-migrations`: |
Member
There was a problem hiding this comment.
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.
Member
There was a problem hiding this comment.
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.
| ## 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` |
Member
There was a problem hiding this comment.
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>
alexmerlin
reviewed
Nov 21, 2025
Member
There was a problem hiding this comment.
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
approved these changes
Nov 21, 2025
alexmerlin
approved these changes
Nov 21, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.