Commit Graph

31 Commits

Author SHA1 Message Date
Shahed Nasser
009d00f27d docs: redesign table of content (#12647)
* implement toc

* added to projects

* fixes and adapt for references

* added product frontmatter

* remove action menu from 404 pages
2025-05-30 16:55:36 +03:00
Rick Gao
38710c116e docs: Replace api_key_id with publishable_key_id (#12242)
<img width="1000" alt="image" src="https://github.com/user-attachments/assets/885395f0-0c74-4cf3-a39b-8d6d97ed0a9c" />
2025-04-21 13:32:03 +00:00
Shahed Nasser
c8ec59e323 docs: updates to link to other modules docs (#12225) 2025-04-18 09:28:39 +03:00
Shahed Nasser
eb73bdb478 docs: rename Architectural Modules to Infrastructure Modules (#12212)
* docs: rename Architectural Modules to Infrastructure Modules

* generate again
2025-04-17 13:20:43 +03:00
Shahed Nasser
857a26ff17 docs: improve links to other modules docs (#11868) 2025-03-17 12:17:39 +02:00
Shahed Nasser
95eef899f7 docs: add notes + missing links for user guide (#11621)
* docs: add notes + missing links for user guide

* fix build errors

* fixes
2025-02-26 15:28:18 +02:00
Shahed Nasser
44706ef03b docs: add workflow and js sdk reference pages for commerce modules (#10898)
* docs: add workflow and js sdk reference pages for commerce modules

* resolve build errors
2025-01-09 18:19:40 +02:00
Shahed Nasser
38223e5104 docs: rename remoteLink and remoteQueryConfig (#10836)
* docs: rename remoteLink and remoteQueryConfig

* change version number
2025-01-07 14:43:12 +02:00
Shahed Nasser
ebca8fed28 docs: revise commerce modules overview pages (#10738)
* revise API Key Module overview

* revise auth module

* support ref sidebar items

* remove examples

* revise cart module

* revise currency

* revise customer module

* revise fulfillment module

* revise inventory module

* revise order module

* revise payment

* revise pricing module

* revise product module

* revise promotion module

* revise region module

* revise sales channel module

* revise stock location module

* revise store module

* revise tax module

* revise user module

* lint content + fix snippets
2024-12-26 10:32:16 +02:00
Shahed Nasser
8441d2ab9d docs: improve link docs for commerce modules (#10726) 2024-12-24 17:19:39 +02:00
Shahed Nasser
041baafd38 docs: split admin widget zone to pages (#10719) 2024-12-24 12:29:41 +02:00
Shahed Nasser
3409953c4f docs: use tooling convention across docs (#10512) 2024-12-09 19:15:29 +02:00
Shahed Nasser
eed88c95ec docs: improved commerce modules [5/5] (#9592)
- Improve remaining commerce modules
- Other: add a note about using methods of the modules' main services.
2024-10-16 10:25:21 +00:00
Shahed Nasser
69b9e73be7 docs: improve commerce modules [1/n] (#9498)
Improve and add docs for API Key, Auth, and Cart Modules

[1/n]
2024-10-11 15:19:13 +00:00
Shahed Nasser
00a51b59b1 docs: update imports of middlewares and http types (#9440) 2024-10-03 15:56:58 +00:00
Shahed Nasser
2e16949979 docs: update imports and package names across docs (#9375)
* docs: update imports and package names across docs
+ reference configs

* generate files

* fix import

* change preview to rc
2024-10-01 11:03:42 +02:00
Shahed Nasser
8584031041 docs: replace ModuleRegistrationName with Modules (#9142) 2024-09-16 15:30:03 +03:00
Shahed Nasser
4b663a4559 docs: document events reference (#9080)
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
2024-09-10 12:20:09 +00:00
Shahed Nasser
3eb2387746 docs: fix pricing query params in storefront guide + modules restructure (#9021)
- Fix pricing query params previously using `customer_group_id` and `customer_id` as expected / accepted queries and update information around them
- Other: reorganize the introduction page of each module to show how to use it at the very beginning.
2024-09-09 06:43:43 +00:00
Shahed Nasser
b8ba020cd5 docs: redesign tables (#8653)
* docs: redesign tables

* fixes
2024-08-20 14:47:36 +02:00
Viktor Bakurin
be8afcaa63 docs: fix ModuleRegistrationName import (#8434)
Closes #8433
2024-08-05 07:24:27 +00: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
6713d76db3 docs: prepare configuration (#7877)
* update configuration

* resolve todos + remove events guides

* disable v2 docs in v1 navbar

* remove v2 from v1 mobile sidebar

* resolve build errors

* fix build errors

* fix lint errors

* fix lint
2024-07-03 19:27:13 +03:00
Carlos R. L. Rodrigues
a7844efd09 chore: move ModuleRegistrationName to utils (#7911) 2024-07-03 06:30:56 -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
c1db40b564 docs: added customer storefront guides (#7685)
* added customer guides

* fixes to sidebar

* remove old customer registration guide

* fix build error

* generate files

* run linter
2024-06-13 12:21:54 +03:00
Shahed Nasser
4a6327e497 docs: make code blocks collapsible (#7606)
* added collapsible code feature

* fixed side shadow

* fix build errors

* change design

* make code blocks collapsible
2024-06-05 10:28:41 +03:00
Shahed Nasser
fe96bd39b1 docs: change config snippets to use defineConfig (#7546) 2024-05-30 16:47:28 +03:00
Shahed Nasser
2c5ba408d4 docs: edits and fixes to commerce module docs (#7468)
Apply edits and fixes to the commerce modules docs
2024-05-29 11:08:06 +00:00
Shahed Nasser
9b1998b9b2 docs: update events reference (#7321)
* change subscribers events

* add event references for modules
2024-05-16 09:01:12 +02: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