From 4fb93b48427072fb3c0acd4646bb083404746087 Mon Sep 17 00:00:00 2001 From: Mikhail Zotyev Date: Sun, 28 Jul 2024 18:10:44 +0200 Subject: [PATCH] Docs: add links to website. (#105) --- README.md | 6 +- packages/elementary/README.md | 4 +- .../elementary/documentation/quick_start.md | 82 ------------------- packages/elementary_helper/README.md | 2 +- packages/elementary_test/README.md | 2 +- 5 files changed, 9 insertions(+), 87 deletions(-) delete mode 100644 packages/elementary/documentation/quick_start.md diff --git a/README.md b/README.md index 865d587a..74db6b6c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Flutter Elementary repository ###

- Elementary Logo + Elementary Logo

### @@ -37,6 +37,10 @@ Elementary is a simple and reliable way to build applications with MVVM in Flutt - **High testability**: All layers, from widgets to business logic, are highly testable. - **Team efficiency**: It boosts speed for teams consisting of more than one person, due to the easy sharing of independent task parts among team members. +## Documentation + +Learn more at our website with [documentation](https://documentation.elementaryteam.dev/"). + ## Environment To reduce the amount of boilerplate and manual work, Elementary offers a few options: diff --git a/packages/elementary/README.md b/packages/elementary/README.md index eea5b557..a91d31cf 100644 --- a/packages/elementary/README.md +++ b/packages/elementary/README.md @@ -1,7 +1,7 @@ # Elementary ###

- Elementary Logo + Elementary Logo

### @@ -52,7 +52,7 @@ A good way to demonstrate the library's functionality without technical details ## Crossroad -If you’re not interested in the technical implementation details or the reasons behind specific decisions, follow this [simple guideline](https://github.com/Elementary-team/flutter-elementary/blob/main/packages/elementary/documentation/quick_start.md) to quickly start using the library. +If you’re not interested in the technical implementation details or the reasons behind specific decisions, follow this [simple guideline](https://documentation.elementaryteam.dev/tutorials/qs/tooling/) to quickly start using the library. For those interested in the technical details and rationale behind our decisions, welcome to the next section of this documentation. diff --git a/packages/elementary/documentation/quick_start.md b/packages/elementary/documentation/quick_start.md deleted file mode 100644 index c78a332b..00000000 --- a/packages/elementary/documentation/quick_start.md +++ /dev/null @@ -1,82 +0,0 @@ -# Document describes a simple guideline how to start with Elementary [WIP] - -### Choose tooling: - -Depends on your IDE and personal preferences choose and install one of those tools: - -- [plugin for IntelliJ](https://plugins.jetbrains.com/plugin/18099-elementary) -- [plugin for VSCode](https://marketplace.visualstudio.com/items?itemName=ElementaryTeam.elementary) -- [elementary brick](https://brickhub.dev/bricks/elementary) -- [elementary_cli](https://pub.dev/packages/elementary_cli); - -Or can skip this step and create Widgets, Widget Models, Models manually further. - -### Depend on elementary: - -Run this command - -```flutter pub add elementary``` - -or manually add dependency to your project pubspec.yaml - -``` -dependencies: - elementary: $actual_version -``` -### Depend on elementary_helper: - -Run this command - -```flutter pub add elementary_helper``` - -or manually add dependency to your project pubspec.yaml - -``` -dependencies: - elementary_helper: $actual_version -``` - -### Depend on elementary_test: - -Run this command - -```flutter pub add elementary_test``` - -or manually add dependency to your project pubspec.yaml - -``` -dependencies: - elementary_test: $actual_version -``` - -### Create classes: - -Using a chosen tool create classes for ElementaryModel, WidgetModel, ElementaryWidget. - -TODO: describe manual creation. - -### ElementaryModel: - -Implement all business logic for current feature in model, free style. - -TODO: more details, examples. - -### WidgetModel: - -Implement all presentation logic for current feature in widget model. - -TODO: more details, examples. - -### ElementaryWidget: - -Based on the contract of Widget Model, describe UI. - -TODO: more details, examples. - -### Testing: - -Write unit tests for Model. -Write tests for Widget Model using elementary_test. -Write widget test, golden tests for ElementaryWidget. - -TODO: more details, examples. \ No newline at end of file diff --git a/packages/elementary_helper/README.md b/packages/elementary_helper/README.md index 77989e9e..867e869b 100644 --- a/packages/elementary_helper/README.md +++ b/packages/elementary_helper/README.md @@ -1,7 +1,7 @@ # Elementary-helper ###

- Elementary Logo + Elementary Logo

### diff --git a/packages/elementary_test/README.md b/packages/elementary_test/README.md index f258c82e..3fb6b770 100644 --- a/packages/elementary_test/README.md +++ b/packages/elementary_test/README.md @@ -1,7 +1,7 @@ # Elementary-test ###

- Elementary Logo + Elementary Logo

###