Skip to content

Commit 5de8d34

Browse files
committed
updated faq - added empty line
1 parent c54a966 commit 5de8d34

21 files changed

Lines changed: 66 additions & 0 deletions

docs/book/v1/admin/introduction.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,15 @@ Dotkernel Admin:
1919
## FAQ
2020

2121
**Q: What is Dotkernel Admin?**
22+
2223
A: It's a skeleton application for quickly setting up an administration site to manage records in your database.
2324

2425
**Q: Does Dotkernel Admin include reporting features?**
26+
2527
A: Yes, it has built-in reports and graphs to help you monitor your platform.
2628

2729
**Q: What standards does Dotkernel Admin implement?**
30+
2831
A: PSR-7 and PSR-15, as defined by the PHP Framework Interop Group (PHP-FIG).
2932

3033
## See also

docs/book/v1/admin/usage.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,15 @@ Later on you can add:
2020
## FAQ
2121

2222
**Q: Can Dotkernel Admin be used on its own?**
23+
2324
A: Yes, it can be installed independently and integrated into your existing platform.
2425

2526
**Q: Are Dotkernel Admin, API, and Queue part of the same codebase?**
27+
2628
A: No, out of the box they are separate codebases designed to complement each other.
2729

2830
**Q: What do Dotkernel API and Dotkernel Queue add to Admin?**
31+
2932
A: The API handles data manipulation for the platform, and Queue handles asynchronous task processing.
3033

3134
## See also

docs/book/v1/api/introduction.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,15 @@ Dotkernel API:
1818
## FAQ
1919

2020
**Q: What is Dotkernel API built on?**
21+
2122
A: It's a REST API based on the Mezzio skeleton.
2223

2324
**Q: What role does Dotkernel API play in the Headless Platform?**
25+
2426
A: It is the root of the Dotkernel Headless Platform.
2527

2628
**Q: What standards does Dotkernel API implement?**
29+
2730
A: PSR-7 and PSR-15, as defined by the PHP Framework Interop Group (PHP-FIG).
2831

2932
## See also

docs/book/v1/api/usage.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,15 @@ Later on you can add:
2323
## FAQ
2424

2525
**Q: Should I start with Dotkernel API or Admin?**
26+
2627
A: Starting with Dotkernel API is a safe bet since it can manage access permissions to keep your data secure.
2728

2829
**Q: How does Dotkernel API separate admin and regular users?**
30+
2931
A: Admin-level users create and edit the data, while regular users read the data for your frontend.
3032

3133
**Q: What can I add to Dotkernel API later?**
34+
3235
A: Dotkernel Admin for its table-based management, reports and graphs, and Dotkernel Queue for asynchronous task processing.
3336

3437
## See also

docs/book/v1/architecture.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,13 @@ Regardless of which pieces you use, every Dotkernel application and package boot
2323
## FAQ
2424

2525
**Q: What are the building blocks of the Dotkernel Headless Platform?**
26+
2627
A: Dotkernel API, Dotkernel Admin, Dotkernel Queue, and the Core submodule.
2728

2829
**Q: Do I need all four components to get started?**
30+
2931
A: No, you can start with just Admin or just API and add the others as your requirements grow.
3032

3133
**Q: How do multiple applications stay consistent with each other?**
34+
3235
A: By sharing a Core submodule for entities and services, and by each bootstrapping through its own ConfigProvider.

docs/book/v1/config-provider/benefits.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,15 @@ Lists the benefits of using a ConfigProvider, including centralized, modular, co
1818
## FAQ
1919

2020
**Q: Why use a ConfigProvider instead of hardcoding bootstrap code?**
21+
2122
A: It centralizes configuration so it's easy to read, change, or extend.
2223

2324
**Q: Does a ConfigProvider work with dependency injection containers?**
25+
2426
A: Yes, it's container-friendly and works with DI containers like Laminas ServiceManager, PHP-DI, or Pimple.
2527

2628
**Q: Do I need to register Dotkernel ConfigProviders manually?**
29+
2730
A: Yes, Dotkernel ConfigProviders must be added manually in `config/config.php`.
2831

2932
## See also

docs/book/v1/config-provider/functionality.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,15 @@ Below you can see how Mezzio and Dotkernel merge and use ConfigProviders to buil
3131
## FAQ
3232

3333
**Q: When is the ConfigProvider picked up?**
34+
3435
A: Automatically, by the framework during application bootstrap.
3536

3637
**Q: What happens during the "Resolve item" step?**
38+
3739
A: `$app->pipe()` resolves a service name from the container, wraps a middleware array, or calls a closure/invokable object.
3840

3941
**Q: Why does the error-handling middleware run last in the pipeline?**
42+
4043
A: So it can catch any exceptions raised by the preceding middleware.
4144

4245
## See also

docs/book/v1/config-provider/introduction.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,15 @@ All Dotkernel applications and packages use ConfigProviders:
6161
## FAQ
6262

6363
**Q: What does a ConfigProvider return in Dotkernel?**
64+
6465
A: Dependency injection mappings, request handlers, and template file paths.
6566

6667
**Q: Which Dotkernel applications use ConfigProviders?**
68+
6769
A: Dotkernel API, Admin, Frontend, Light, and Packages all use ConfigProviders.
6870

6971
**Q: Is the Dotkernel ConfigProvider approach specific to Dotkernel?**
72+
7073
A: No, it follows an approach similar to Laminas/Mezzio.
7174

7275
## See also

docs/book/v1/core/benefits.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,15 @@ This ensures consistency throughout your platform, while allowing any number of
2020
## FAQ
2121

2222
**Q: How does the Core submodule pattern help as a platform grows?**
23+
2324
A: It provides design flexibility and scalability suited for both enterprise and smaller applications.
2425

2526
**Q: Can multiple developers work on the platform using this pattern?**
27+
2628
A: Yes, it allows splitting the work across multiple developers.
2729

2830
**Q: How do new applications connect to the platform?**
31+
2932
A: Each new application connects via the central API, which services everything the other applications require.
3033

3134
## See also

docs/book/v1/core/creation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,23 @@ git submodule update
6060
## FAQ
6161

6262
**Q: Where can I find the full steps for creating a Git submodule?**
63+
6364
A: In the official Git documentation, [Git Tools – Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
6465

6566
**Q: What command creates a submodule in an application?**
67+
6668
A: `git submodule add <url>`, using the URL of the new Core repository.
6769

6870
**Q: How do I get the submodule after cloning the project?**
71+
6972
A: Run `git submodule init` followed by `git submodule update`.
7073

7174
**Q: Should I keep the existing Core module after adding the submodule?**
75+
7276
A: No, delete the existing Core module before adding the submodule to other applications.
7377

7478
**Q: Will I lose the Core folder's Git history when I create the submodule?**
79+
7580
A: Yes, unless you extract it first with a history-preserving tool such as `git subtree split` — simply creating an empty repository and adding it as a submodule does not carry over the folder's original history.
7681

7782
## See also

0 commit comments

Comments
 (0)