Skip to content

awell-health/developer-hub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Awell Developers

Repository for Awell Health's developer portal. The portal houses the documentation and API reference for our Orchestration API.

NPM Next JS TailwindCSS Commitizen friendly

Getting Started

Installation

First, install all packages via npm.

npm i

You can then run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Editing files

Most of the content is managed through mdx files and these can be found in /content/**/*. Editing the markdown file will automatically update the content.

Pages that are not managed through mdx files can be edit in the /pages directory.

Adding a new page

  1. Create a .mdx file in the appropriate location (eg /content/awell-orchestration/docs/getting-started/new-doc.mdx)
  2. Add your new page to the menu, this is not done automatically! See /src/config/menus/*.ts and add your new page to the appropriate file: docsMenu if it's a documentation page and apiMenu if it's a page that belongs to the API reference.
  3. That's it!

Credits

Website built with NextJS and Tailwind. We ❤️ the Tailwind docs so we've used their layout and some of the components from their website. We've also used some components from Flowbite.