# Documentation

The application uses hybrid documentation to stay up-to-date. Each **package README and internal structure are auto-generated**.

The auto-generated documentation is generated from js-doc like comments:

* **`@extPoint`** - allows marking a function as great for place for extension<br>
* **`@extExample`** - allows providing a ready (copy-paste) extension example<br>
* **`@example`** - allows specifying an example of function usage<br>
* **`@namespace`** - namespace of the function according to the plugin mechanism

If your module is located in `packages` folder of original mono-repository the documentation can be automatically extracted with `yarn docs` command.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://scandipwa.gitbook.io/shopify/architecture/documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.