Merge pull request #43 from gacela-project/feture/link-docs-to-website

Link the docs to the website
gacela-project · Jul 15, 2021 · 2e532be · 2e532be
2 parents 391939f + 2231d93
commit 2e532be
Show file tree

Hide file tree

Showing 9 changed files with 7 additions and 334 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,5 @@
 <p align="center">
-  <a href="http://gacela-project.com/" title="Gacela Website">
-    <img src="docs/imgs/gacela-logo-blue.svg" width="350" alt="Gacela logo"/>
-  </a>
+  <img src="gacela-logo.svg" width="350" alt="Gacela logo"/>
 </p>
 
 <p align="center">
@@ -33,25 +31,20 @@ scalability. It will certainly encourage your modules to interact with each othe
 rules:
 
 - Different modules can interact **only** via their `Facade`.
-- The `Facade` has access to the `Factory`.
-- The `Factory` creates the objects from the module and has access to the Module's `Config`.
-- The `Config` gets the values from your defined config files.
-- The `DependencyProvider` uses the Locator to get the Facades from different modules.
+- The [`Facade`](https://gacela-project.com/docs/facade/) has access to the `Factory`.
+- The [`Factory`](https://gacela-project.com/docs/factory/) creates the objects from the module and has access to the Module's `Config`.
+- The [`Config`](https://gacela-project.com/docs/config/) gets the values from your defined config files.
+- The [`DependencyProvider`](https://gacela-project.com/docs/dependency-provider/) uses the Locator to get the Facades from different modules.
 
 ### Installation
 
 ```bash
 composer require gacela-project/gacela
 ```
 
-## Documentation
+### Documentation
 
-- [Basic concepts](docs/001_basic_concepts.md): What are the characteristics of a module?
-- [Facade](docs/002_facade.md): The entry point of your module
-- [Factory](docs/003_factory.md): The place where you create your domain services and objects
-- [Config](docs/004_config.md): Reads the values defined in your config path
-- [DependencyProvider](docs/005_dependency_provider.md): It defines the dependencies between modules
-- [Code generator](docs/006_code_generator.md): Some commands out-of-the-box for generating code
+You can check the full documentation in the official [website](https://gacela-project.com/).
 
 ### Examples
 

diff --git a/docs/001_basic_concepts.md b/docs/001_basic_concepts.md
diff --git a/docs/002_facade.md b/docs/002_facade.md
diff --git a/docs/003_factory.md b/docs/003_factory.md
diff --git a/docs/004_config.md b/docs/004_config.md
diff --git a/docs/005_dependency_provider.md b/docs/005_dependency_provider.md
diff --git a/docs/006_code_generator.md b/docs/006_code_generator.md
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/imgs/gacela-logo-blue.svg → gacela-logo.svg b/docs/imgs/gacela-logo-blue.svg → gacela-logo.svg