api-ref: custom API reference (medusajs#4770)

* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies

.changeset/fluffy-shoes-peel.md

@@ -0,0 +1,5 @@
+---
+"@medusajs/oas-github-ci": patch
+---
+
+feat(@medusajs/oas-github-ci): Improvements for custom API reference

.github/workflows/docs-test.yml

@@ -2,8 +2,8 @@ name: Documentation Tests
 on: 
   pull_request:
     paths:
-      - docs/content/**
       - www/docs/**
+      - www/api-reference/**
 jobs:
   docs-test:
     runs-on: ubuntu-latest
@@ -52,7 +52,7 @@ jobs:
           fetch-depth: 0
 
       - name: Get Directories to Scan
-        working-directory: docs
+        working-directory: www/docs/vale
         run: ./get-files.sh
         id: directories
 
@@ -79,14 +79,14 @@ jobs:
           fetch-depth: 0
 
       - name: Install dependencies
-        uses: ./.github/actions/cache-deps
-        with:
-          extension: eslint-docs
+        working-directory: www/docs
+        run: yarn install
 
       - name: Run Eslint
-        run: yarn lint:docs
+        working-directory: www/docs
+        run: yarn lint:content
 
-  code-eslint:
+  code-docs-eslint:
     runs-on: ubuntu-latest
     steps:
       - name: Cancel Previous Runs
@@ -105,4 +105,25 @@ jobs:
 
       - name: Run Eslint
         working-directory: www/docs
+        run: yarn lint
+
+  code-api-ref-eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+
+      - name: Install dependencies
+        working-directory: www/api-reference
+        run: yarn install
+
+      - name: Run Eslint
+        working-directory: www/api-reference
         run: yarn lint

.github/workflows/generate-api-reference.yml

@@ -43,6 +43,6 @@ jobs:
           base: 'develop'
           title: 'chore(docs): Updated API Reference'
           labels: 'type: chore'
-          add-paths: docs/api/*
+          add-paths: www/api-reference/specs
           branch: 'chore/generate-api-ref'
           branch-suffix: 'timestamp'

.github/workflows/generate-entity-reference.yml

@@ -42,6 +42,6 @@ jobs:
           base: 'develop'
           title: 'chore(docs): Generated Entities Reference (automated)'
           labels: 'type: chore'
-          add-paths: docs/content/references/entities/**
+          add-paths: www/docs/content/references/entities/**
           branch: 'chore/generate-entities'
           branch-suffix: 'timestamp'

.github/workflows/generate-js-reference.yml

@@ -42,6 +42,6 @@ jobs:
           base: 'develop'
           title: 'chore(docs): Generated JS Client Reference'
           labels: 'type: chore'
-          add-paths: docs/content/references/js-client/**
+          add-paths: www/docs/content/references/js-client/**
           branch: 'chore/generate-js-client'
           branch-suffix: 'timestamp'

.github/workflows/generate-reference.yml

@@ -42,6 +42,6 @@ jobs:
           base: 'develop'
           title: 'chore(docs): Generated Services Reference (automated)'
           labels: 'type: chore'
-          add-paths: docs/content/references/services/**
+          add-paths: www/docs/content/references/services/**
           branch: 'chore/generate-services'
           branch-suffix: 'timestamp'

.vale.ini

@@ -1,4 +1,4 @@
-StylesPath = docs/styles
+StylesPath = www/docs/vale/styles
 
 MinAlertLevel = suggestion
 Vocab = Base

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}