Shahed Nasser
c1a5390fc6
docs: translation module ( #14271 )
...
* docs: translation module
* fix link in JS SDK
* add translations user guides [WIP]
* updates
* fix broken link
* remove mentions of default locale
* change header
* updates
* updated user guides
* handle todos
* fix build error
* fix lint errors
2025-12-17 13:07:43 +02:00
Shahed Nasser
0084460765
docs: various improvements and fixes ( #14257 )
2025-12-09 16:16:45 +02:00
Bastien and Shahed Nasser
7652329489
docs: add custom admin route ranking documentation ( #13984 )
...
## Summary
**What** — What changes are introduced in this PR?
Related PR #13946
Add custom admin route ranking documentation
**Why** — Why are these changes relevant or necessary?
*Please provide answer here*
**How** — How have these changes been implemented?
*Please provide answer here*
**Testing** — How have these changes been tested, or how can the reviewer test the feature?
*Please provide answer here*
---
## Examples
Provide examples or code snippets that demonstrate how this feature works, or how it can be used in practice.
This helps with documentation and ensures maintainers can quickly understand and verify the change.
```ts
// Example usage
```
---
## Checklist
Please ensure the following before requesting a review:
- [ ] I have added a **changeset** for this PR
- Every non-breaking change should be marked as a **patch**
- To add a changeset, run `yarn changeset` and follow the prompts
- [ ] The changes are covered by relevant **tests**
- [ ] I have verified the code works as intended locally
- [ ] I have linked the related issue(s) if applicable
---
## Additional Context
Add any additional context, related issues, or references that might help the reviewer understand this PR.
---
> [!NOTE]
> Adds admin UI docs for sidebar route ranking (including nested), sorting rules, and examples using CodeTabs; mirrors updates in the public content file.
>
> - **Docs (Admin UI Routes)** in `www/apps/book/app/learn/fundamentals/admin/ui-routes/page.mdx`:
> - Add `rank` property to `defineRouteConfig` docs and explain sidebar ordering.
> - New section: "Specify UI Route Sidebar Rank" with version note (v2.11.4).
> - Add sorting rules for ranked vs. unranked routes.
> - Add "Nested UI Routes Ranking" with examples under `orders`.
> - Provide two example routes (Analytics, Reports) demonstrating rank via `CodeTabs`/`CodeTab` (and import them).
> - Minor copy tweaks (e.g., possessive fix in `label` description).
> - **Public content mirror** in `www/apps/book/public/llms-full.txt`:
> - Sync the above additions: `rank` property, ranking section, sorting rules, nested ranking examples, and copy fixes.
>
> <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot ) for commit 1d127afbfb01e034c39b0b02081781bd0a8e29ef. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot ).</sup>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com >
2025-12-03 15:41:43 +00:00
Shahed Nasser
2087c8d155
docs: add best practices doc for third-party syncing ( #14203 )
...
* docs: add best practices doc for third-party syncing
* small fix
2025-12-03 15:47:41 +02:00
Shahed Nasser
223ccb4add
docs: docs for next release ( #14110 )
2025-12-01 20:20:01 +02:00
Shahed Nasser
815464e007
docs: clarify how links with cascade deletion are deleted ( #14155 )
...
* docs: clarify how links with cascade deletion are deleted
* small change
2025-12-01 09:01:50 +02:00
Shahed Nasser
c3cebdfe80
docs: fix events payloads ( #14131 )
2025-11-26 16:12:00 +02:00
Shahed Nasser
c1ede88a7e
docs: document locks for nested workflows ( #14130 )
...
* docs: document locks for nested workflows
* smal text change
* fix build error
2025-11-26 15:36:58 +02:00
Shahed Nasser
76660fb6cc
docs: add keywords to cloud, fixes to installation and Index Module docs ( #14129 )
...
* docs: add keywords to cloud, fixes to installation and Index Module docs
* fix vale error
2025-11-26 14:36:29 +02:00
Shahed Nasser
7975d8522e
docs: docs for next release ( #13907 )
2025-10-31 11:28:42 +02:00
Shahed Nasser
540ae996ff
docs: fix mikro-orm imports from framework ( #13885 )
2025-10-28 18:27:34 +02:00
Shahed Nasser
a9dbd035a5
docs: documented admin translations ( #13864 )
2025-10-27 12:04:31 +02:00
Shahed Nasser
4ab185c685
docs: clarify how emitEventStep emits an event in a workflow ( #13836 )
2025-10-23 16:30:25 +03:00
Shahed Nasser
76f9da5ef4
docs: Caching Module ( #13701 )
...
* standard docs for caching module + deprecated cache module
* added guides for creating + using, and overall changes from cache to caching
* fix details related to redis provider
* fix build errors
* fix build error
* fixes
* add guides to sidebar
* add sidebar util
* document query + index
* moved cache tag conventions
* fix build errors
* added migration guide
* added memcached guide
* fixes
* general fixes and updates
* updated reference
* document medusa cache
* small fix
* fixes
* remove cloud cache
* revert edit dates changes
* revert edit dates
* small update
2025-10-21 10:34:27 +03:00
Shahed Nasser
ed715813a5
docs: docs for next release ( #13621 )
...
* docs: docs for next release
* changes to opentelemetry dependencies
* document plugin env variables
* document admin changes
* fix vale error
* add version notes
* document campaign budget updates
* document campaign changes in user guide
* document chages in cluster mode cli
* documented once promotion allocation
* document multiple API keys support
2025-10-21 10:32:08 +03:00
Shahed Nasser
ee2734c23d
docs: add troubleshooting for middlewares ( #13764 )
2025-10-16 14:43:21 +03:00
Shahed Nasser
4eb9628514
docs: add troubleshooting for subscribers + scheduled jobs not working ( #13762 )
2025-10-16 13:07:37 +03:00
Shahed Nasser
1ca329d9b3
docs: clarify relation name for read-only links ( #13758 )
...
* docs: clarify relation name for read-only links
* small fix
* fix vale error
2025-10-16 10:27:14 +03:00
Shahed Nasser
a5df43cde7
docs: fix limit text length code ( #13752 )
2025-10-16 08:23:29 +03:00
Shahed Nasser
50c1417378
docs: improve troubleshooting guide for pnpm ( #13673 )
...
* docs: improve troubleshooting guide for pnpm
* added pnpm link to installation guide
2025-10-03 13:09:01 +03:00
Shahed Nasser
05af008911
docs: add details about updating index module's data source ( #13637 )
...
* docs: add details about updating index module's data source
* small change
2025-10-01 10:26:11 +03:00
Shahed Nasser
bd9ecd5e66
docs: updates to custom columns and build guides ( #13624 )
2025-09-30 10:01:58 +03:00
Shahed Nasser
ba9a30757b
docs: general improvements ( #13530 )
2025-09-17 08:48:18 +03:00
Shahed Nasser
d4891381fc
docs: general improvements and fixes ( #13515 )
2025-09-16 08:48:27 +03:00
Shahed Nasser
5589b7351a
docs: documentation updates for v2.10.2 ( #13500 )
2025-09-15 13:56:50 +03:00
Shahed Nasser
e90dcedcd7
docs: general improvements and updates ( #13485 )
...
* docs: general improvements and updates
* fix vale error
2025-09-15 12:30:59 +03:00
Shahed Nasser
8785fb4e1a
docs: general fixes and improvements ( #13417 )
2025-09-04 19:27:34 +03:00
Shahed Nasser
1578e1ad22
docs: add more examples for API route responses ( #13399 )
2025-09-03 10:36:24 +03:00
Shahed Nasser
e96c0e4d09
docs: document feature flags ( #13388 )
2025-09-02 12:26:54 +03:00
Shahed Nasser
f39ba53fd3
docs: document scheduled jobs interval ( #13350 )
2025-08-29 15:14:26 +03:00
Shahed Nasser
27bb69390d
docs: general fixes to admin tips document ( #13253 )
2025-08-20 15:09:26 +03:00
Shahed Nasser
fa16503005
docs: improve file uploads example + add section on overriding body size limit ( #13250 )
2025-08-20 14:07:19 +03:00
Teodor Raykov
c42155ff73
docs: fix typos in index modules docs ( #12852 )
2025-08-18 09:35:58 +03:00
Shahed Nasser
14de565077
docs: fixes to read-only links + add examples for filtering by relations ( #13218 )
2025-08-15 16:48:28 +03:00
Chirag Singh
c2ba01acd6
Update page.mdx ( #13180 )
...
Fixed a typo: "percision" to "precision"
2025-08-11 06:47:36 +00:00
Shahed Nasser
89886ba518
docs: general updates to documentation pages ( #13128 )
2025-08-01 18:59:46 +03:00
Shahed Nasser
f9ca2691be
docs: document the fetchStream method of the JS SDK ( #13125 )
2025-08-01 17:47:26 +03:00
Shahed Nasser
6ec530b2a5
docs: add buffer example in workflows + tip for type error in admin global variables ( #13124 )
2025-08-01 17:15:47 +03:00
Shahed Nasser
b0d0e7b1a6
docs: updates to nested workflow docs ( #13117 )
2025-08-01 11:54:41 +03:00
Shahed Nasser
7bf8ecc013
docs: update list of resources in module containers + conventions on loaders ( #13107 )
2025-07-31 18:14:39 +03:00
Shahed Nasser
a48063ec26
docs: add link to manage metadata section in OAS and API reference ( #13102 )
2025-07-31 14:42:14 +03:00
Shahed Nasser
54a74b0215
docs: document JSON properties ( #13099 )
2025-07-31 12:22:32 +03:00
Shahed Nasser
cd599e1f62
docs: general updates to documentation pages ( #13055 )
2025-07-28 10:52:22 +03:00
Shahed Nasser
0d8c2c4056
docs: document auto-generated types ( #13050 )
2025-07-25 17:48:18 +03:00
Shahed Nasser
5a01ef89ea
docs: document checks examples + migrations naming convention ( #13052 )
2025-07-25 17:22:37 +03:00
Shahed Nasser
b40b2ff676
docs: improvements and additions to admin customization chapters ( #13049 )
2025-07-25 16:19:22 +03:00
Shahed Nasser
d22b6257b7
docs: fix passing linkable for inverse read-only links ( #13041 )
2025-07-25 13:27:06 +03:00
Shahed Nasser
7b3dc917a2
docs: document UI route breadcrumbs ( #13035 )
...
* docs: document UI route breadcrumbs
* add section on dynamic breadcrumbs + improvements
2025-07-25 10:56:31 +03:00
Shahed Nasser
c71ace0be2
docs: added Docker local installation guide ( #13022 )
...
* docs: added Docker local installation guide
* fixes
2025-07-23 19:00:38 +03:00
mathieuh
23a33f08b2
docs: fix typos in learn and recipes ( #13017 )
2025-07-22 16:51:57 +03:00