Commit Graph

35 Commits

Author SHA1 Message Date
Shahed Nasser ba3a572a89 docs: various improvements to introduction guides (#14398) 2025-12-24 15:37:37 +02:00
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
Bastien 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 223ccb4add docs: docs for next release (#14110) 2025-12-01 20:20:01 +02:00
Shahed Nasser 7975d8522e docs: docs for next release (#13907) 2025-10-31 11:28:42 +02:00
Shahed Nasser a9dbd035a5 docs: documented admin translations (#13864) 2025-10-27 12:04:31 +02: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 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 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 27bb69390d docs: general fixes to admin tips document (#13253) 2025-08-20 15:09: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 cd599e1f62 docs: general updates to documentation pages (#13055) 2025-07-28 10:52:22 +03:00
Shahed Nasser b40b2ff676 docs: improvements and additions to admin customization chapters (#13049) 2025-07-25 16:19:22 +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
mathieuh 23a33f08b2 docs: fix typos in learn and recipes (#13017) 2025-07-22 16:51:57 +03:00
Shahed Nasser 0a43009580 docs: freshness check for some guides (#13000) 2025-07-21 17:36:37 +03:00
Shahed Nasser e7cf2219b6 docs: document using env vars in plugins (#12618) 2025-05-26 18:50:05 +03:00
Victor Wilson 728c350c0d Update page.mdx to correct "th" to "the" (#12446)
The first paragraph is missing an "e" in its first "the". I added that.
2025-05-12 16:34:06 +00:00
Shahed Nasser 750b1e9bbf docs: improvements to admin, query, and read-only link docs (#12239)
* improve admin page

* improvemens to query and read-only link docs

* fix build error
2025-04-18 14:41:25 +03:00
Shahed Nasser cbd1786ca5 docs: small improvements to the general deployment guide (#11978) 2025-03-25 19:25:53 +02:00
Shahed Nasser 2ec59ddadc docs: typos and examples fixes (#11954)
* docs: typos and examples fixes

* fix notification example
2025-03-24 09:33:22 +02:00
Shahed Nasser 4c33586946 docs: added troubleshooting guides + improvements (#11927)
* docs: added troubleshooting guides + improvements

* build fixes
2025-03-21 11:47:03 +02:00
Shahed Nasser ac989a6ed1 moved configurations page 2025-03-11 10:59:29 +02:00
Shahed Nasser ecc3deb362 docs: changes to main docs sidebar (#11750)
* docs: changes to main docs sidebar

* fix links

* fix vale test

* fix vale errors
2025-03-06 11:55:56 +02:00
Shahed Nasser 31f8b72129 docs: updates for 2.5.1 release (#11574)
* docs: updates for 2.5.1 release

* update
2025-02-24 13:02:26 +02:00
Shahed Nasser 062805d533 docs: add sections on predefined environment and global variables (#11510) 2025-02-18 19:12:38 +02:00
Shahed Nasser 7d0ba7037b docs: add railway troubleshooting for host (#11346) 2025-02-06 15:54:54 +02:00
Shahed Nasser d348204fe5 docs: document admin environment variables (#11313) 2025-02-05 11:47:07 +02:00
Shahed Nasser ff093a7735 docs: update tanstack query version (#11246) 2025-01-31 16:39:36 +02:00
Shahed Nasser b0a2699e01 docs: fix tanstack query version (#11162) 2025-01-27 09:48:03 +02:00
Shahed Nasser 2fe98c9712 docs: add a note about installing tanstack query as a dev dependency (#11123) 2025-01-23 19:16:52 +02:00
Eugene Pro b278ee5ff1 docs: how to add new admin route under existing route (#10652)
* docs: how to add new admin route under existing route

* docs: update about defineRouteConfig

* docs: add new line

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>

* docs: add new line

---------

Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2025-01-20 15:21:09 +02:00
Shahed Nasser d070c09185 docs: add documentation on sending requests to custom routes with JS SDK (#10582) 2024-12-12 14:47:00 +02:00
Shahed Nasser 3409953c4f docs: use tooling convention across docs (#10512) 2024-12-09 19:15:29 +02:00
Shahed Nasser 0ae98c51eb docs: revise main docs outline (#10502) 2024-12-09 13:54:42 +02:00