Commit Graph

14 Commits

Author SHA1 Message Date
Shahed Nasser
d9b9a1df27 docs: add a section about constraints on step return value (#8036)
Rename the workflow constructor constraints document to include also step constraints and add a section about the allowed return value of a step.
2024-07-10 13:21:53 +00:00
Shahed Nasser
273529fde5 docs: added chapter on managing relationships (#8043) 2024-07-09 18:12:00 +03:00
Shahed Nasser
964927b597 docs: general fixes and improvements (#7918)
* docs improvements and changes

* updated module definition

* modules + dml changes

* fix build

* fix vale error

* fix lint errors

* fixes to stripe docs

* fix condition

* fix condition

* fix module defintion

* fix checkout

* disable UI action

* change oas preview action

* flatten provider module options

* fix lint errors

* add module link docs

* pr comments fixes

* fix vale error

* change node engine version

* links -> linkable

* add note about database name

* small fixes

* link fixes

* fix response code in api reference

* added migrations step
2024-07-04 17:26:03 +03:00
Shahed Nasser
0aeba83a66 docs: update scheduled jobs docs (#7905)
- Update scheduled jobs docs to support updated definition + remove coming soon notice
- Update scheduled jobs everywhere else they're used.
2024-07-02 09:41:15 +00:00
Shahed Nasser
6cb28eedf7 docs: document composite indices + primary key changes (#7902) 2024-07-02 12:34:44 +03:00
Shahed Nasser
b62f23ea00 docs: additions and improvements to modules and DML documentation (#7854)
* docs: additions and improvements to modules and DML documentation

* small wording fix
2024-07-01 10:26:40 +03:00
Shahed Nasser
0462cc5acf docs: updates to use DML and other changes (#7834)
- Change existing data model guides and add new ones for DML
- Change module's docs around service factory + remove guides that are now necessary
- Hide/remove all mentions of module relationships, or label them as coming soon.
- Change all data model creation snippets to use DML
- use `property` instead of `field` when referring to a data model's properties.
- Fix all snippets in commerce module guides to use new method suffix (no more main model methods)
- Rework recipes, removing/hiding a lot of sections as a lot of recipes are incomplete with the current state of DML.


### Other changes

- Highlight fixes in some guides
- Remove feature flags guide
- Fix code block styles when there are no line numbers.

### Upcoming changes in other PRs

- Re-generate commerce module references (for the updates in the method names)
- Ensure that the data model references are generated correctly for models using DML.
- (probably at a very later point) revisit recipes
2024-06-26 07:55:59 +00:00
Shahed Nasser
46c5c5fe28 docs: added storefront regions guides (#7623) 2024-06-09 15:19:09 +02:00
Shahed Nasser
130de74d6d docs: updates to admin customization docs (#7493)
* updated admin docs

* re-add navigation and parameters sections

* update injection zones

* update cli scripts docs

* added list of injection zones

* add details about widget props

* restructure admin injection zones
2024-05-29 13:50:19 +03:00
Shahed Nasser
154673f3d8 docs: fixes and changes based on latest updates (#7322)
* docs: changes based on DX changes

* remove fields no longer needed

* remove unnecessary parameters

* fixes to authenticate middleware usage

* add highlight to migrations config

* change configuration to http

* added missing remote link docs

* fix name in sidebar

* added notification module docs + updated file module docs

* add vale exceptions

* fix vale errors

* added docs on custom cli scripts
2024-05-22 13:37:48 +03:00
Shahed Nasser
803e4aad02 docs: added file module docs (#7278) 2024-05-13 18:54:59 +03:00
Shahed Nasser
327e446974 docs: general fixes and overall changes (#7258)
* editing halfway

* edited second half

* adjust starter steps

* fix build

* typo fix
2024-05-07 18:00:28 +02:00
Shahed Nasser
14d15df866 docs: added advanced workflows documentation (#7252) 2024-05-07 10:32:36 +03:00
Shahed Nasser
4fe28f5a95 chore: reorganize docs apps (#7228)
* reorganize docs apps

* add README

* fix directory

* add condition for old docs
2024-05-03 17:36:38 +03:00