docs: document headless, atomic, and atomic-react entry points (#4455)

https://coveord.atlassian.net/browse/KIT-3579
coveo · Sep 24, 2024 · 3853bdc · 3853bdc
1 parent bab0883
commit 3853bdc
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/packages/atomic-react/README.md b/packages/atomic-react/README.md
@@ -24,6 +24,14 @@ Since Atomic React is built on top of the core [Atomic](https://docs.coveo.com/e
 
 However, there are still some special considerations.
 
+## Entry points
+
+The `@coveo/atomic-react` package exposes the following entry points:
+
+- `@coveo/atomic-react`: exports the components and utilities for building non-commerce search interfaces with Atomic React.
+- `@coveo/atomic-react/recommendation`: exports the components and utilities for building non-commerce recommendation interfaces with Atomic React.
+- `@coveo/atomic-react/commerce`: exports the components and utilities for building commerce applications with Atomic React.
+
 ## Static Assets - Languages and SVGs
 
 For performance reasons, the generated JavaScript bundle does not automatically include static assets that are loaded on demand. This impacts language support, as well as the use of included SVG icons.

diff --git a/packages/atomic/README.md b/packages/atomic/README.md
@@ -7,6 +7,16 @@ A web-component library for building modern UIs interfacing with the Coveo platf
 
 Using the library: [Coveo Atomic Library Official Documentation](https://docs.coveo.com/en/atomic/latest/).
 
+## Entry points
+
+The `@coveo/atomic` package exposes the following entry points:
+
+- `@coveo/atomic`: exports various types and utilities used by Coveo Atomic.
+- `@coveo/atomic/loader`: exports the Coveo Atomic components types, as well as the `defineCustomElements` and `setNonce` utilities.
+- `@coveo/atomic/themes`: exports the sample Coveo Atomic themes.
+- `@coveo/atomic/assets`: exports the SVG icons used by Coveo Atomic.
+- `@coveo/atomic/lang`: exports the localization files used by Coveo Atomic.
+
 ## Getting Started
 
 Once you have cloned the repo, follow the instructions in the top-level [README.md](../../README.md) to install dependencies and link packages.

diff --git a/packages/headless/README.md b/packages/headless/README.md
@@ -4,6 +4,22 @@
 
 Using the library: [Coveo Headless Library Official Documentation](https://docs.coveo.com/en/headless/latest/).
 
+## Entry points
+
+The `@coveo/headless` package exposes several entry points.
+
+The entry point from which you will import Coveo Headless resources depends on the engine type you are using:
+
+| Engine type           | Entry point                      |
+| --------------------- | -------------------------------- |
+| Search engine         | `@coveo/headless`                |
+| Search SSR engine     | `@coveo/headless/ssr`            |
+| CaseAssist engine     | `@coveo/headless/case-assist`    |
+| Commerce engine       | `@coveo/headless/commerce`       |
+| Commerce SSR engine   | `@coveo/headless/ssr-commerce`   |
+| Insight engine        | `@coveo/headless/insight`        |
+| Recommendation engine | `@coveo/headless/recommendation` |
+
 ## Contributing
 
 ### Getting started