Skip to content

Commit

Permalink
docs(components): update documentation on components
Browse files Browse the repository at this point in the history
  • Loading branch information
@matthieu-crouzet
matthieu-crouzet committed Apr 9, 2024
1 parent a3b2f60 commit fc6b271
Show file tree
Hide file tree
Showing 36 changed files with 530 additions and 726 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ The documentation is sorted by topic but in the table below, you shall find the
| @o3r/apis-manager | Service to help you communicate with your APIs | @o3r/dev-tools | [API_MANAGER](./apis-manager/API_MANAGER.md) |
| @o3r/application | Provides development tools for your Otter application | @o3r/core <br/> @o3r/dev-tools | |
| @o3r/chrome-devtools | Chrome plugin to debug your Otter application | N/A | [chrome-devtools](./dev-tools/chrome-devtools.md) |
| @o3r/components | Component related features (Component replacement, CMS compatibility, helpers, pipes, debugging developer tools...) <br/> Comes with an integrated ng builder | @o3r/analytics <br/> @o3r/build-helpers <br/> @o3r/configuration <br/> @o3r/core <br> @o3r/dev-tools <br/> @o3r/extractors <br/> @o3r/localization <br/> @o3r/logger <br> @o3r/schematics <br/> @o3r/testing | [COMPONENT_STRUCTURE](./components/COMPONENT_STRUCTURE.md) <br/> [COMPONENT_STYLE_OVERRIDE](./components/COMPONENT_STYLE_OVERRIDE.md) <br/> [CONTAINER_PRESENTER](./components/CONTAINER_PRESENTER.md) <br/> [FIXTURES](./components/FIXTURES.md) <br/> [NAMING_CONVENTION](./components/NAMING_CONVENTION.md) <br/> [COMPONENT_REPLACEMENT](./components/COMPONENT_REPLACEMENT.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/components | Component related features (Component replacement, CMS compatibility, helpers, pipes, debugging developer tools...) <br/> Comes with an integrated ng builder | @o3r/analytics <br/> @o3r/build-helpers <br/> @o3r/configuration <br/> @o3r/core <br> @o3r/dev-tools <br/> @o3r/extractors <br/> @o3r/localization <br/> @o3r/logger <br> @o3r/schematics <br/> @o3r/testing | [COMPONENT INTRODUCTION](./components/INTRODUCTION.md) <br/> [COMPONENT_STYLE_OVERRIDE](./components/COMPONENT_STYLE_OVERRIDE.md) <br/> [CONTAINER_PRESENTER](./components/CONTAINER_PRESENTER.md) <br/> [FIXTURES](./components/FIXTURES.md) <br/> [COMPONENT_REPLACEMENT](./components/COMPONENT_REPLACEMENT.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/configuration | Configuration related features (CMS compatibility, Configuration override, store and debugging) | @o3r/core <br/> @o3r/dev-tools <br/> @o3r/logger <br/> @o3r/testing | [OVERVIEW](./configuration/OVERVIEW.md) <br/> [CONFIGURATION_SUPPORTED_EXTRACTOR](./configuration/CONFIGURATION_SUPPORTED_EXTRACTOR.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/core | Foundation for all the packages (interfaces, core helpers) and schematics to generate your components/services etc. | N/A | [START_NEW_APPLICATION](./core/START_NEW_APPLICATION.md) <br/> [DEVELOPER](./core/DEVELOPER.md) <br/> [OTTER_ANGULAR_TOOLS](./core/OTTER_ANGULAR_TOOLS.md) |
| @o3r/design | Tools to generate theme from design materials | N/A | [TECHNICAL_DOCUMENTATION](./design/TECHNICAL_DOCUMENTATION.md) |
| @o3r/dev-tools | Various CLI scripts to help your CI/CD and your dependency management | N/A | [DEV_TOOLS](./dev-tools/DEV_TOOLS.md) |
| @o3r/dynamic-content | Mechanism to retrieve media and data depending on the host or a server specific url | @o3r/core <br/> @o3r/dev-tools | [DYNAMIC_CONTENT](./dynamic-content/DYNAMIC_CONTENT.md) <br/> [LOCALHOST_MIDDLEWARE](./dynamic-content/LOCALHOST_MIDDLEWARE.md) |
| @o3r/eslint-plugin | In-house eslint plugins to use in your own eslint configuration | N/A | [eslint-plugin](./linter/eslint-plugin.md) |
| @o3r/extractors | Utilities to extract your application metadata to interact with your CMS | @o3r/core <br/> @o3r/dev-tools | |
| @o3r/forms | Utilities to enhance angular form (asynchronous decorator, additional validator, error store...) | @o3r/core <br/> @o3r/dev-tools | [README](./forms/README.md) <br/> [FORM_ERRORS](./forms/FORM_ERRORS.md) <br/> [FORM_STRUCTURE](./forms/FORM_STRUCTURE.md) <br/> [FORM_SUBMIT_AND_INTERCOMMUNICATION](./forms/FORM_SUBMIT_AND_INTERCOMMUNICATION.md) <br/> [FORM_VALIDATION](./forms/FORM_VALIDATION.md) |
| @o3r/forms | Utilities to enhance Angular form (asynchronous decorator, additional validator, error store...) | @o3r/core <br/> @o3r/dev-tools | [README](./forms/README.md) <br/> [FORM_ERRORS](./forms/FORM_ERRORS.md) <br/> [FORM_STRUCTURE](./forms/FORM_STRUCTURE.md) <br/> [FORM_SUBMIT_AND_INTERCOMMUNICATION](./forms/FORM_SUBMIT_AND_INTERCOMMUNICATION.md) <br/> [FORM_VALIDATION](./forms/FORM_VALIDATION.md) |
| @o3r/localization | Provide a fallback language/translation support and debug tools | @o3r/core <br/> @o3r/dev-tools | [LOCALIZATION](./localization/LOCALIZATION.md) <br/> [CMS_ADAPTERS](./cms-adapters/CMS_ADAPTERS.md) |
| @o3r/logger | Bridge to target different logger (logrocket, fullstory, smartlook) with a common interface | N/A | [LOGS](./logger/LOGS.md) |
| @o3r/mobile | Helpers and store to integrate Capacitor into your Otter application. <br/> Integration with the pCloudy API for e2e testing on real devices. | @o3r/core <br/> @o3r/logger | |
Expand Down

0 comments on commit fc6b271

Please sign in to comment.