Shahed Nasser
cb33388202
docs: add line highlight validation ( #14380 )
...
* docs: add line highlight validation
* add to all projects
* fixes
* fixes
* fix
* fixes
2025-12-22 14:10:39 +02:00
Shahed Nasser
d1a1135328
docs: migrate UI docs ( #13245 )
...
* docs: create a new UI docs project (#13233 )
* docs: create a new UI docs project
* fix installation errors
* docs: migrate UI docs content to new project (#13241 )
* Fix content
* added examples for some components
* finish adding examples
* lint fix
* fix build errors
* delete empty files
* path fixes + refactor
* fix build error
2025-08-20 11:42:25 +03:00
Shahed Nasser
5122ced9f6
docs: prepare cloud docs ( #12784 )
...
* initial
* fixes
* docs: prepare cloud docs
2025-06-20 12:59:38 +03:00
Shahed Nasser
f25a4a5e34
docs: add script to catch bad redirects ( #12361 )
...
* docs: add script to catch bad redirects
* add missing dependency
2025-05-05 12:49:05 +03:00
Shahed Nasser
9ead47c51e
docs: add prepare script to generate sidebar ( #11894 )
2025-03-18 17:37:51 +02:00
Shahed Nasser
b45c1e1580
docs: prepare projects configurations for user guide ( #11610 )
...
* docs: prepare projects configurations for user guide
* fix build error
2025-02-26 10:01:30 +02:00
Shahed Nasser
e7e36f39fb
docs: support detecting broken link cross-projects ( #10483 )
...
* docs: support detecting broken link cross-projects
* remove double separators
2024-12-06 19:54:46 +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
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
522d3ce764
docs: improvements to API reference intro sections ( #9397 )
...
- Improve intro sections of API reference to utilize divided columns
- Improve the content of the intro sections
- Add a new Workflows section to explain the workflows badge and how to use it
- Fixes to headings and add anchor for copying the link to a section
- Fixes responsiveness of intro sections on mobile devices
- Other: fix loading not showing when a sidebar category is opened.
Closes DOCS-932, DOCS-934, DOCS-937
Preview: https://api-reference-v2-git-docs-api-ref-intro-fixes-medusajs.vercel.app/v2/api/store
2024-10-06 16:51:08 +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
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
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
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
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
761d2e7a69
docs: update documentation websites ( #5882 )
...
* docs: update next.js to 14.0.4
* update docusaurus to v3.0.1
* update packages dependencies
* added engines
* update lock
2023-12-14 20:43:16 +02:00
Shahed Nasser
fa7c94b4cc
docs: create docs workspace ( #5174 )
...
* docs: migrate ui docs to docs universe
* created yarn workspace
* added eslint and tsconfig configurations
* fix eslint configurations
* fixed eslint configurations
* shared tailwind configurations
* added shared ui package
* added more shared components
* migrating more components
* made details components shared
* move InlineCode component
* moved InputText
* moved Loading component
* Moved Modal component
* moved Select components
* Moved Tooltip component
* moved Search components
* moved ColorMode provider
* Moved Notification components and providers
* used icons package
* use UI colors in api-reference
* moved Navbar component
* used Navbar and Search in UI docs
* added Feedback to UI docs
* general enhancements
* fix color mode
* added copy colors file from ui-preset
* added features and enhancements to UI docs
* move Sidebar component and provider
* general fixes and preparations for deployment
* update docusaurus version
* adjusted versions
* fix output directory
* remove rootDirectory property
* fix yarn.lock
* moved code component
* added vale for all docs MD and MDX
* fix tests
* fix vale error
* fix deployment errors
* change ignore commands
* add output directory
* fix docs test
* general fixes
* content fixes
* fix announcement script
* added changeset
* fix vale checks
* added nofilter option
* fix vale error
2023-09-21 20:57:15 +03:00
