Skip to content

Commit

Permalink
Update assets folder
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosas committed Aug 19, 2023
1 parent 26e664f commit 4159047
Show file tree
Hide file tree
Showing 16 changed files with 11 additions and 12 deletions.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img width="500px" src=".assets/contributing.png" alt="Contributing">
<img width="500px" src="assets/contributing.png" alt="Contributing">
</p>

# Contributing
Expand Down
10 changes: 5 additions & 5 deletions docs/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following sections illustrate some typical checks you could perform.
#### Layered Architecture

<p align="center">
<img width="500px" src=".assets/layered.png" alt="Layered">
<img width="500px" src="assets/layered.png" alt="Layered">
</p>

If you are organizing your code in layers (e.g. with an onion structure), you might want to ensure that
Expand All @@ -22,7 +22,7 @@ the inner layers do not depend on the outer ones:
#### Model-View-Controller

<p align="center">
<img width="500px" src=".assets/mvc.png" alt="MVC">
<img width="500px" src="assets/mvc.png" alt="MVC">
</p>

If you are using a MVC approach, you could ensure that both model and view are not coupled to controllers. You also might want to check that they are not coupled to each other:
Expand All @@ -42,7 +42,7 @@ If you are using a MVC approach, you could ensure that both model and view are n
#### Aggregates

<p align="center">
<img width="500px" src=".assets/aggregates.png" alt="Aggregates">
<img width="500px" src="assets/aggregates.png" alt="Aggregates">
</p>

You won't want your classes to have direct access to the members of an aggregate, except for the aggregate root.
Expand All @@ -59,7 +59,7 @@ If you have, for instance, an AggregateRootInterface you can create a rule like
#### Enforcing or forbidding an abstract extension

<p align="center">
<img width="500px" src=".assets/abstract.png" alt="Abstract">
<img width="500px" src="assets/abstract.png" alt="Abstract">
</p>

You might want to ensure that a specific type of classes are extending a certain abstract class. Services, Controllers, CommandHandlers, etc.
Expand All @@ -75,7 +75,7 @@ You might want to ensure that a specific type of classes are extending a certain
#### Enforcing or forbidding an interface implementation

<p align="center">
<img width="500px" src=".assets/interface.png" alt="Interface">
<img width="500px" src="assets/interface.png" alt="Interface">
</p>

You might want to ensure that a specific type of classes are implementing a certain interface. ValueObjects, Entities, etc.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#
<p align="center">
<img width="500px" src=".assets/logo.png" alt="PHP Architecture Tester">
<img width="500px" src="assets/logo.png" alt="PHP Architecture Tester">
</p>
<h2 align="center">Easy to use architecture testing tool for PHP</h2>

Expand All @@ -12,7 +12,7 @@
It provides a natural language abstraction that enables you to define your own architectural rules and assess their compliance.

<p align="center">
<img width="700" src=".assets/example.gif" alt="Example">
<img width="700" src="assets/example.gif" alt="Example">
</p>

💡 Check out the [Examples](examples.md) section to get some ideas and see some typical use cases.
Expand Down
7 changes: 3 additions & 4 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,19 @@ site_description: Easy to use architecture testing tool for PHP
repo_url: https://github.com/carlosas/phpat/

docs_dir: ./docs
exclude_docs: .assets

theme:
name: material
logo: .assets/icon.png
favicon: .assets/icon.png
logo: assets/icon.png
favicon: assets/icon.png
font:
text: Noto Sans
code: Noto Mono
features:
- toc.integrate
- footer
extra_css:
- .assets/extra.css
- assets/extra.css

markdown_extensions:
- pymdownx.highlight:
Expand Down

0 comments on commit 4159047

Please sign in to comment.