Commit Graph

60 Commits

Author SHA1 Message Date
Shahed Nasser
0c1bbbac2a docs: integrate google analytics (#10526) 2024-12-10 13:16:12 +02:00
Shahed Nasser
c99b03bcc2 docs: change logo (#10208)
* docs: changed logo

* remove unused component
2024-11-21 18:15:32 +02:00
Shahed Nasser
ab5f2b5e11 docs: update og images (#10206)
* docs: update og images

* fixes
2024-11-21 17:33:50 +02:00
Shahed Nasser
35afa04a93 docs: migrate Kapa (#10198)
* docs: migrate kapa

* remove unused dependency

* fix isbrowser
2024-11-21 15:05:50 +02:00
Shahed Nasser
765f99e04b docs: fix font smoothing across projects (#10183) 2024-11-20 18:24:58 +02:00
Shahed Nasser
a1738f823c docs: change report issue link (#10160) 2024-11-19 15:54:16 +02:00
Shahed Nasser
938f3bd934 docs: update to next 15 + eslint 9 (#9839)
* update next

* updated react

* update eslint

* finish updating eslint

* fix content lint errors

* fix docs test

* fix vale action

* fix installation errors
2024-11-13 17:03:17 +02:00
github-actions[bot]
1c046a14ac chore(docs): Generated UI Reference (automated) (#9801)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
2024-10-26 16:33:11 +02:00
Shahed Nasser
fd26839616 docs: fixes to ui docs (#9759) 2024-10-25 11:56:54 +03:00
Shahed Nasser
88f2d17a24 docs: change configurations to make v2 the main docs (#9729)
* docs: change configurations to make v2 the main docs

* move api routes to top level

* remove api prefix

* update opengraph images

* show v1 link

* add redirect to v1
2024-10-24 14:49:58 +03:00
Shahed Nasser
04cec64fa1 docs: show latest version in docs + update automatically (#9753) 2024-10-24 14:03:34 +03:00
github-actions[bot]
e196ad7659 chore(docs): Updated UI Reference (automated) (#9726)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-24 09:38:58 +00:00
Shahed Nasser
c08df5ac44 docs: remove dev notices + fix AI assistant answer width (#9686)
* docs: remove dev notices + fix AI assistant answer width

* fix import

* more notes removal

* rc to latest
2024-10-23 09:52:52 +02:00
Shahed Nasser
0a37675f0e docs: add routing page (#9550)
- Add a new homepage to `book` project for the routing page
- Move all main doc pages to be under `/v2/learn` (and added redirects + fixed links across docs)
- Other: add admin components to resources dropdown + fixes to search on mobile.

Closes DX-955

Preview: https://docs-v2-git-docs-router-page-medusajs.vercel.app/v2
2024-10-18 08:24:34 +00:00
Shahed Nasser
49a91fd40e docs: redesigned navigation (#9525)
Redesign navigation bar to reflect new design and allow for dropdowns

Closes DX-943
2024-10-11 07:10:00 +00:00
Shahed Nasser
ab5a7ca691 docs: fix infinite scroll, update next.js, other fixes (#9441)
* update nextjs

* badge + scroll fixes
2024-10-03 14:17:33 +03:00
Shahed Nasser
0f6f56e764 docs: DX and performance improvements in API reference (#9430)
- Improve scroll behavior between active sections
- Improve lag when clicking on a sidebar item
- Refactor internal working of the `SidebarProvider` to find active items faster.
- Use Next.js's `useRouter` hook for changing the hash (since they added the option to disable scroll)
- Change `isBrowser` from a hook to a provider since it's widely used across applications.
- Other general improvements and fixes.

Closes DOCS-952
2024-10-02 15:51:02 +00:00
Shahed Nasser
138523a629 docs: change navbar items + breadcrumb improvements (#9209)
- Add a new commerce module navbar item
- Rename Learning Resources to Development Resources (in navbar and across documentation content)
- Improve breadcrumbs to show categories / subcategories

Preview: https://resources-docs-git-docs-navbar-changes-medusajs.vercel.app/v2/resources
2024-09-22 12:47:35 +00:00
Shahed Nasser
320b01f45d docs: redesign search + re-introduce ai assistant in v2 docs (#8678)
* docs: redesign search + re-introduce ai assistant in v2

* change version in ui

* show icon in case of error

* fixes based on feedback
2024-08-23 10:42:37 +03:00
Shahed Nasser
b4d8e265e3 docs: redesign cards (#8671)
* docs: redesign cards

* fix build error
2024-08-20 14:48:17 +02:00
Shahed Nasser
b8ba020cd5 docs: redesign tables (#8653)
* docs: redesign tables

* fixes
2024-08-20 14:47:36 +02:00
Shahed Nasser
0cc2a62b9b docs: collapse sidebar by default in main docs + persist state (#8608)
* docs: collapse sidebar by default in main docs + persist state

* persist sidebar hidden
2024-08-16 09:29:14 +03:00
Shahed Nasser
f00e61707c docs: update colors and typography (#8604) 2024-08-16 09:28:16 +03:00
Shahed Nasser
b4f3b8a79d docs: redesign sidebar (#8408)
* initial changes

* redesign the sidebar + nav drawer

* changes to sidebar items

* finish up sidebar redesign

* support new sidebar in resources

* general fixes

* integrate in ui

* support api reference

* refactor

* integrate in user guide

* docs: fix build errors

* fix user guide build

* more refactoring

* added banner

* added bottom logo + icon

* fix up sidebar

* fix up paddings

* fix shadow bottom

* docs: add table of content (#8445)

* add toc types

* implement toc functionality

* finished toc redesign

* redesigned table of content

* mobile fixes

* truncate text in toc

* mobile fixes

* merge fixes

* implement redesign

* add hide sidebar

* add menu action item

* finish up hide sidebar design

* implement redesign in resources

* integrate in api reference

* integrate changes in ui

* fixes to api reference scrolling

* fix build error

* fix build errors

* fixes

* fixes to sidebar

* general fixes

* fix active category not closing

* fix long titles
2024-08-15 12:13:13 +03:00
Shahed Nasser
ccc99b48a0 docs: add 404 page (#8260) 2024-07-24 17:07:30 +03:00
Shahed Nasser
4c89f91caf docs: fix download button + other fixes (#8032)
- Fix text of download button
- Small fix to styling on small devies
- Fix mobile sidebar items using incorrect base url
2024-07-09 12:36:02 +00: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
Shahed Nasser
c38f6d07c2 docs: update design + colors (#7593)
Update design and colors in docs to match those in Figma
2024-06-04 07:41:24 +00:00
Muhammad Naimul Islam
2b55208c1c docs: fix component title and description in alert.mdx (#7435)
- Removed the incorrect title and description from the Alert component page
- Added new title and description for the Alert component page
2024-05-24 15:55:42 +00:00
Shahed Nasser
22f30f54fd docs: update api-reference project for v2 (#7307)
* remove everything v1 and make v2 default

* move main v2 rewrites to book

* move rewrites to book + other fixes
2024-05-16 09:02:35 +02:00
Shahed Nasser
728c5ee53c docs: preparations for preview (#7267)
* configured base paths + added development banner

* fix typelist site url

* added navbar and sidebar badges

* configure algolia filters

* remove AI assistant

* remove unused imports

* change navbar text and badge

* lint fixes

* fix build error

* add to api reference rewrites

* fix build error

* fix build errors in user-guide

* fix feedback component

* add parent title to pagination

* added breadcrumbs component

* remove user-guide links

* resolve todos

* fix details about authentication

* change documentation title

* lint content
2024-05-13 11:32:52 +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
Shahed Nasser
b6083ce104 docs: added documentation for toast component changes (#7141)
* docs: added documentation for toast component changes

* added redirect from use-toast docs to upgrade guide

* remove unused file

* content linting fixes

* update UI package version

* updated ui preset

* fix upgrade guides main page
2024-05-01 18:12:10 +03:00
github-actions[bot]
d24c819e7d chore(docs): Updated UI Reference (#6754)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-03-22 15:26:11 +00:00
Shahed Nasser
bb87db8342 docs: prep for v2 documentation (#6710)
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs).

_Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._

## Changes

- Change Medusa version in base OAS used for v2.
- Fix to docblock generator related to not catching all path parameters.
- Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules.
- Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used.
- Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment.
- Upgraded docusaurus to v3.0.1
- Added new Vale rules to ensure correct spelling of Medusa Admin and module names.
- Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 07:47:35 +00:00
Shahed Nasser
3b18f399c1 docs(ui): show icon tooltip on small devices (#6407) 2024-02-26 08:31:36 +01:00
github-actions[bot]
869dc751a0 chore(docs): Updated UI Reference (#6347)
* chore(docs): Generated UI Reference

* fixed props typing + added new alert page

* updated ui dependencies

---------

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2024-02-12 19:46:51 +01:00
github-actions[bot]
dfd9e7c772 chore(docs): Updated UI Reference (#6221)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-01-29 08:20:51 +00:00
Shahed Nasser
0b0c25da11 docs: update dependencies (#6046) 2024-01-10 10:56:54 +02:00
Shahed Nasser
97fd67bdd3 docs: improvements of docs UI (#6038)
* docs: improvements of docs UI

* changed note about icon sizes
2024-01-09 19:21:12 +02:00
Shahed Nasser
18de90e603 docs: fix tsdocs following typedoc update + 1.20 release (#6033)
* docs: fix tsdocs following typedoc update + 1.20 release

* Fix OAS validation errors

* fixes to react-docs-generator

* fix content linting
2024-01-09 17:15:29 +02:00
Shahed Nasser
c0ce969cd7 docs: fixed sidebar in API reference (#5871) 2023-12-14 13:26:24 +02:00
Shahed Nasser
245e5c9a69 docs: generate documentation for UI components (#5849)
* added tool to generate spec files for React components

* use typedoc for missing descriptions and types

* improvements and fixes

* improvements

* added doc comments for half of the components

* add custom resolver + more doc comments

* added all tsdocs

* general improvements

* add specs to UI docs

* added github action

* remove unnecessary api route

* Added readme for react-docs-generator

* remove comment

* Update packages/design-system/ui/src/components/currency-input/currency-input.tsx

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>

* remove description of aria fields + add generate script

---------

Co-authored-by: Kasper Fabricius Kristensen <45367945+kasperkristensen@users.noreply.github.com>
2023-12-13 16:02:41 +02:00
Kasper Fabricius Kristensen
a67a8e7e90 fix(ui): Fixed CodeBlock line number width (#5640)
**What**
- Fixes the width of lineNumbers in the CodeBlock component according to the widest number.
- Introduces a new prop on snippets that allows users to hide the copy button. Also updated docs to reflect this.

Before:
![image](https://github.com/medusajs/medusa/assets/45367945/07852c2e-434c-44df-93b7-4078148cb74f)

After:
<img width="742" alt="image" src="https://github.com/medusajs/medusa/assets/45367945/5ce845f7-b8c7-411c-abfb-fa03448aeb1a">

Closes #5639
2023-11-16 10:50:04 +00:00
Kasper Fabricius Kristensen
a2a45b6fef fix: minor fixes to IconButton and Button documentation (#5636)
**What**
- Updates example on IconButton page so it no longer uses IconBadge
- Removes the "small" size from Button props as it no longer exists.
2023-11-15 15:53:05 +00:00
Shahed Nasser
c28935b4e8 docs: update endpoints to use file-routing approach (#5397)
- Move the original guides for creating endpoints and middlewares to sub-sections in the Endpoints category.
- Replace existing guides for endpoints and middlewares with the new approach.
- Update all endpoints-related snippets across docs to use this new approach.
2023-10-19 15:56:26 +00:00
Shahed Nasser
4ca70a0d0c docs: fix horizontal scroll (#5300) 2023-10-05 22:38:54 +03:00
Shahed Nasser
b3f75d8f21 docs: add AI Assistant (#5249)
* added components

* added ai assistant button

* change styling

* improve AI assistant

* change to a drawer

* added command support into search

* add AiAssistant to all projects

* remove usage of Text component

* added error handling

* use recaptcha

* fix new configurations

* fix background color

* change suggested questions
2023-10-05 11:10:44 +03:00
Shahed Nasser
7016c8940c docs: fix design issues (#5252)
* docs: fix design issues

* fix commands in installation tabs
2023-09-29 17:17:24 +03:00
Tek Loon
dc298acefc docs(admin-ui): Fix incorrect Radix UI Select Reference Link (#5248)
* fix: add ProductCollectionDetailsWidgetProps

* fix(doc): fix incorrect Radix UI Select reference link

---------

Co-authored-by: Tek Loon <tekloon.1991@gmail.com>
2023-09-29 12:47:11 +03:00