Commit Graph

75 Commits

Author SHA1 Message Date
Shahed Nasser
a77c23c915 docs: redesign code highlights + add default code titles (#8628)
* docs: code highlights improvements + default titles

* spacing fixes

* fix terminal detection

* add padding for non-terminal one liners
2024-08-19 13:34:07 +03:00
Shahed Nasser
800d034c89 docs: update algolia (#8625)
Update algolia to fix issues with highlighting and snippets
2024-08-19 07:12:02 +00:00
Shahed Nasser
c479fe8220 docs: added edit date (#8623) 2024-08-19 09:47:57 +03:00
Shahed Nasser
66c39ef876 docs: bug fixes for copy and color mode (#8626)
* docs: bug fixes for copy and color mode

* remove unused dependency
2024-08-18 17:01:15 +02:00
Shahed Nasser
559a6d70d9 docs: remove steps from workflows reference overview (#8595)
* docs: remove steps from workflows reference overview

* fix styling of typelist element

* fix categories with no items showing
2024-08-16 12:37:13 +03:00
Shahed Nasser
9bdcdc76a8 docs: redesign help button (#8610)
Redesign help button

Closes DOCS-817
2024-08-16 06:40:05 +00: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
12728f17ad docs: fix scroll top margin (#8605) 2024-08-16 09:28:02 +03:00
Shahed Nasser
5abe9f9c66 docs: fix expand badge (#8611)
* fix component

* update expand URL
2024-08-16 09:26:16 +03:00
Shahed Nasser
47eb19ca5d docs: add associated workflow badge in api reference (#8613) 2024-08-16 09:26:04 +03:00
Shahed Nasser
0b6bc7e05f docs: redesign pagination (#8614) 2024-08-16 09:25:53 +03:00
Shahed Nasser
4bd0917aed docs: change workflow diagram to list (#8602) 2024-08-15 16:47:27 +03:00
Shahed Nasser
3bdfb66238 docs: change from showing required to showing optional in types references (#8593) 2024-08-15 16:29:49 +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
cd0acbd921 docs: fixes and preparations for workflows reference (#8579)
- Fix the merger configuration that adds the correct slug / sidebar labels
- Add an overview page for the workflows reference.
- Fixes to components and build scripts
2024-08-13 12:30:55 +00: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
a19c562bec docs-util: add support for workflows in markdown theme (#8485)
* add template for workflows

* initial changes

* added support for parallel steps

* added support for when

* added merge options

* fix merge options

* fix to tooltip

* clean up

* remove redirects

* fixes

* theme fixes + added merge options

* generate hook examples + fixes

* changed namespaces

* add custom autogenerator

* change type of additional data
2024-08-09 16:35:52 +03:00
Shahed Nasser
2682e2e324 docs: fix sidebar not updating when api reference path changes (#8409) 2024-08-05 13:20:53 +03:00
Shahed Nasser
a8df528c65 docs: add a need help button (#8069)
* docs: add a need help button

* change github issue link

* responsive fixes
2024-07-11 10:29:13 +03:00
Carlos R. L. Rodrigues
de36e2b36e chore: rename return flow (#8050) 2024-07-10 08:09:10 -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
3d6b1dc7ae docs: fix page crashing when using google translate (#8009) 2024-07-08 10:24:45 +02: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
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
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
85d487d90b docs: added checkout storefront guides (#7678)
* add first guides

* added more guides

* finished payment + added stripe

* finished adding guides

* updated generated sidebar
2024-06-12 19:46:06 +02:00
Shahed Nasser
6946814944 docs: update recipes to be based on v2 (#7516) 2024-06-09 15:18:43 +02: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
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
65be42c818 docs: add integrations page (#7421)
* add integrations page

* update payment provider docs

* use stripe icon
2024-05-28 13:25:03 +03:00
Shahed Nasser
5d4bf83145 docs: fix code block highlighting for lines starting with spaces (#7356) 2024-05-20 09:49:52 +03: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
9b1998b9b2 docs: update events reference (#7321)
* change subscribers events

* add event references for modules
2024-05-16 09:01:12 +02:00
Shahed Nasser
70c4ffff8b docs: improve API testing feature (#7311) 2024-05-14 10:12:53 +03: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
803e4aad02 docs: added file module docs (#7278) 2024-05-13 18:54:59 +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
327e446974 docs: general fixes and overall changes (#7258)
* editing halfway

* edited second half

* adjust starter steps

* fix build

* typo fix
2024-05-07 18:00:28 +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
Shahed Nasser
793184bf42 docs: improvements to railway deployment guide + new troubleshooting guide (#7012) 2024-04-15 09:30:31 +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
Shahed Nasser
82db53c99e docs: fix search in api reference (#6578)
* docs: fix search in api reference

* remove log messages
2024-03-05 10:02:56 +01: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
ddc0c9dfff docs: add anchor link to reference parameters (#6194)
- Added anchor links to items in parameter components
- Added sectionTitle prop in markdown theme

Note: Due to the second point, the change requires generating references to see the anchor links, which would result in a big diff in this PR. Instead, next time the references are generated for a release, this feature will available for use.
2024-01-24 08:42:55 +00: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