asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
6,091 Commits 2 Branches 0 Tags
b4f3b8a79deead79678793efceacbd9d891864d1
Commit Graph

79 Commits

Author SHA1 Message Date
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
35da5dedc1 docs: fix build errors + update medusa docs link (#8550) 
* docs: update medusa docs link

* fix @medusajs/icon version

* fix user guide build

* fix build error
 2024-08-13 08:51:20 +02:00
Shahed Nasser
041019b319 docs: merge allOf in OAS to show all object types (#8453) 
* docs: merge allOf in OAS to show all object types

* add case for non objects
 2024-08-06 09:57:09 +03:00
Shahed Nasser
2682e2e324 docs: fix sidebar not updating when api reference path changes (#8409) 2024-08-05 13:20:53 +03:00
github-actions[bot]
31ec4d0d71 chore(docs): Updated API Reference (v2) (#8384) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
 2024-08-01 07:43:40 +00:00
github-actions[bot]
749e86b5d8 chore(docs): Updated API Reference (v2) (#8361) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
 2024-07-31 07:33:02 +00:00
github-actions[bot]
a2a377c8ca chore(docs): Updated API Reference (v2) (#8345) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
 2024-07-30 07:30:58 +00:00
github-actions[bot]
e40b4c6183 chore(docs): Generated API Reference (v2) (#8318) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-29 09:41:02 +02:00
github-actions[bot]
13855e9167 chore(docs): Updated API Reference (v2) (#8273) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
 2024-07-25 07:02:12 +00:00
Shahed Nasser
7a0941e997 docs: fix rewrites in sub-projects to prevent loop on 404 page (#8255) 2024-07-24 17:06:54 +03:00
github-actions[bot]
b08d867e8f chore(docs): Generated API Reference (v2) (#8252) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2024-07-24 09:16:25 +02:00
github-actions[bot]
d71b0bac36 chore(docs): Generated API Reference (v2) (#8230) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2024-07-23 13:51:27 +02:00
github-actions[bot]
c99cb5c0ca chore(docs): Updated API Reference (v2) (#8208) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
 2024-07-22 07:10:08 +00:00
Shahed Nasser
c900a104ce docs: fix auth routes in api reference (#8187) 2024-07-18 19:02:14 +02:00
github-actions[bot]
7b49caf18a chore(docs): Generated API Reference (v2) (#8175) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
 2024-07-18 14:49:44 +02:00
github-actions[bot]
1d40b3cc98 chore(docs): Generated API Reference (v2) (#8155) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-17 08:34:42 +01:00
github-actions[bot]
1bd1d4f394 chore(docs): Generated API Reference (v2) (#8127) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-15 09:12:46 +02:00
github-actions[bot]
c88d161587 chore(docs): Generated API Reference (v2) (#8122) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-14 18:03:04 +02:00
github-actions[bot]
3730b79472 chore(docs): Generated API Reference (v2) (#8100) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-12 09:25:00 +02:00
github-actions[bot]
adfa1d8574 chore(docs): Updated API Reference (v2) (#8073) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
 2024-07-11 07:59:07 +00:00
github-actions[bot]
7fa04aabce chore(docs): Generated API Reference (v2) (#8053) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-10 09:35:59 +02: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
github-actions[bot]
6c7a0129e3 chore(docs): Updated API Reference (v2) (#7999) 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
 2024-07-08 08:47:26 +00:00
Shahed Nasser
de0a9c14ab docs: fix pagination on mobile devices (#7968) 
* docs: fix pagination on mobile devices

* fix algolia link
 2024-07-05 12:40:42 +02:00
github-actions[bot]
1162b1625d chore(docs): Generated API Reference (v2) (#7962) 
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
 2024-07-05 09:55:55 +02:00
Shahed Nasser
22dbe34625 docs: fix URL of Algolia cron job (#7957) 2024-07-04 17:32:41 +00:00
Shahed Nasser
92dd855290 docs: restructure api-reference to allow base path (#7954) 2024-07-04 16:12:02 +00:00
Shahed Nasser
1acbcf612e docs: fix api-reference with proxy (#7952) 2024-07-04 17:10:48 +02: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
Shahed Nasser
b9036eca1a docs: generate OAS for v2 (#7883) 2024-07-01 15:35:45 +03:00
Shahed Nasser
2597990363 docs: fix details of selecting fields and relationships in api reference (#7642) 2024-06-09 15:19:51 +02: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
Shahed Nasser
98615c388b docs-util: fixes to base OAS + circular-patch redocly plugin (#7382) 
* docs-util: remove MultipleErrors schema from base OAS

* fixes to circular patch plugin

* general fixes

* change nested schemas to references
 2024-05-27 14:29:48 +02: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
7cb90f8e82 docs: editing and general fixes of medusa's learning resources (#7261) 
* docs: editing and general fixes of medusa's learning resources

* fix build script

* update ui dependency

* fix build

* adjust next.js steps
 2024-05-13 18:55:11 +03: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
1a68f4602c feat(api-ref): show schema of a tag (#7297) 2024-05-10 21:07:35 +03:00
Shahed Nasser
5d0ffe8ff4 docs: refactored versioning in api reference + modified v2 content (#7274) 2024-05-09 17:23:49 +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
7934fbdd1e docs: fix download button in API reference (#7039) 
* docs: fix download button in API reference

* remove comments
 2024-04-15 09:37:24 +02:00
Shahed Nasser
0c12d7e7d7 docs: add note about expanding nested relations (#7008) 2024-04-15 09:32:57 +02:00
github-actions[bot]
85e5478873 chore(docs): Updated API Reference (#6831) 
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-04-02 09:47:04 +00:00
github-actions[bot]
8e3e49fbbf chore(docs): Generated API Reference (#6755) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2024-03-27 18:24:22 +01:00
Shahed Nasser
e005987adf fix(medusa-oas-cli): fix tool not working in Medusa backends (#6812) 
* fix(medusa-oas-cli): fix tool not working in custom projects

* fix changeset message

---------

Co-authored-by: Riqwan Thamir <rmthamir@gmail.com>
 2024-03-26 09:33:06 +02: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
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]
e56c440911 chore(docs): Generated API Reference (#6346) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
 2024-02-08 22:05:15 +01:00
Ira
44470bf8c5 Update all curl documentation examples and references with new x-medusa-access-token header (#6326) 
## What

This is to update incorrect documentation in regards to authentication to the Admin API - raised in https://github.com/medusajs/medusa/issues/6264.

## Why

Because the current documentation has been incorrect since the September 2023 release of [v1.17.0](https://github.com/medusajs/medusa/releases/tag/v1.17.0), which had breaking changes to API token usage.

## How

Simple search and replace. I was asked to replace occurrences under `www/apps/docs/content/` but there were also additional places where I thought references should also be updated:

- `packages/medusa/src/api/`
- `www/apps/api-reference/`

Feel free to revert them as needed.

There is also some inconsistency between the format shown in examples e.g. `<API_TOKEN>` vs `{api_token}` vs `{access_token}`.

I have kept the format the same in all cases as the original, as surrounding documentation text would not have format updated as well. I suggest maybe reviewing the documentation and keeping to a consistent format e.g. `<API_TOKEN>`.

 
## Testing 

I have not tested these changes. I would assume the `packages/medusa/src/api/` changes may need more thorough testing?
 2024-02-07 08:41:38 +00:00
github-actions[bot]
bbf79169a9 chore(docs): Updated API Reference (#6220) 
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-01-25 17:58:17 +00:00