Add docs

Author: maxidragon

.github/workflows/deploy_docs.yml

@@ -0,0 +1,32 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [19.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install dependencies
+      run: yarn install
+      working-directory: ./docs
+    - name: Build
+      run: yarn build
+      working-directory: ./docs
+    - name: Deploy to GitHub Pages
+      uses: JamesIves/github-pages-deploy-action@v4.5.0
+      with:
+        branch: gh-pages
+        folder: ./docs/build

README.md

@@ -12,7 +12,7 @@ This project is loosely based on [Vulcan API](https://github.com/kapi2289/vulcan
 
 ## Docs
 
-[Gitbook docs](https://capure.gitbook.io/vulcan-api-js/)
+You can find the docs [here](https://avorty.github.io/vulcan-api-js)
 
 ## License
 

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/docs/contributing/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Contributing",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "Some details on how to contribute to the project."
+  }
+}

docs/docs/contributing/docs.md

@@ -0,0 +1,29 @@
+---
+sidebar_position: 3
+---
+
+# Contributing to the docs
+
+On every page you can find a link to the source file of the page. You can edit the file and create a pull request.
+
+## Using markdown
+
+If you don't know how to use markdown you can look [here](./markdown-features)
+
+## Adding a new page
+
+To add a new page you need to create a new markdown file in the `docs/docs` folder. 
+
+## Adding a new category
+If you want to create a new category you need to create a new folder in the `docs/docs` folder and create a new markdown file in it. Also you need to create a _category.json file in the category folder with the following content:
+
+```json
+{
+  "label": "New category",
+  "position": 6,
+  "link": {
+    "type": "generated-index",
+    "description": "Short description of the category."
+  }
+}
+```

docs/docs/contributing/general.md

@@ -0,0 +1,17 @@
+---
+sidebar_position: 1
+---
+
+# General information
+
+Contributions are welcome! We are happy to accept contributions in the form of pull requests, issues, or just general feedback and discussion.
+
+## Contributing to the documentation
+
+See [Contributing to the documentation](./docs).
+
+## Contributing to the SDK
+
+See [Contributing to the SDK](./sdk).
+
+If you have any questions feel free to contact us.

docs/docs/contributing/markdown-features.mdx

@@ -0,0 +1,127 @@
+---
+sidebar_position: 4
+---
+
+# Markdown Features
+
+Out docs page uses **Docusaurus**. Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
+
+## Using links
+
+Regular Markdown links are supported, using url paths or relative file paths.
+
+```md
+Returns a [Student](../models/student) object.
+```
+
+Link to [Student](../models/student) model.
+
+## Images
+
+Regular Markdown images are supported.
+
+You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
+
+```md
+![Docusaurus logo](/img/docusaurus.png)
+```
+
+![Docusaurus logo](/img/docusaurus.png)
+
+You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:
+
+```md
+![Docusaurus logo](./img/docusaurus.png)
+```
+
+## Code Blocks
+
+Markdown code blocks are supported with Syntax highlighting.
+
+    ```jsx title="src/components/HelloDocusaurus.js"
+    function HelloDocusaurus() {
+        return (
+            <h1>Hello, Docusaurus!</h1>
+        )
+    }
+    ```
+
+```jsx title="src/components/HelloDocusaurus.js"
+function HelloDocusaurus() {
+  return <h1>Hello, Docusaurus!</h1>;
+}
+```
+
+## Admonitions
+
+Docusaurus has a special syntax to create admonitions and callouts:
+
+    :::tip My tip
+
+    Use this awesome feature option
+
+    :::
+
+    :::danger Take care
+
+    This action is dangerous
+
+    :::
+
+:::tip My tip
+
+Use this awesome feature option
+
+:::
+
+:::danger Take care
+
+This action is dangerous
+
+:::
+
+## MDX and React Components
+
+[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
+
+```jsx
+export const Highlight = ({children, color}) => (
+  <span
+    style={{
+      backgroundColor: color,
+      borderRadius: '20px',
+      color: '#fff',
+      padding: '10px',
+      cursor: 'pointer',
+    }}
+    onClick={() => {
+      alert(`You clicked the color ${color} with label ${children}`)
+    }}>
+    {children}
+  </span>
+);
+
+This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
+
+This is <Highlight color="#1877F2">Facebook blue</Highlight> !
+```
+
+export const Highlight = ({children, color}) => (
+  <span
+    style={{
+      backgroundColor: color,
+      borderRadius: '20px',
+      color: '#fff',
+      padding: '10px',
+      cursor: 'pointer',
+    }}
+    onClick={() => {
+      alert(`You clicked the color ${color} with label ${children}`);
+    }}>
+    {children}
+  </span>
+);
+
+This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
+
+This is <Highlight color="#1877F2">Facebook blue</Highlight> !

docs/docs/contributing/sdk.md

@@ -0,0 +1,23 @@
+---
+sidebar_position: 2
+---
+
+# Contributing to the SDK
+
+You can look on the [list of issues](https://github.com/avorty/vulcan-api-js/issues) and pick one to work on. If you have an idea for a new feature, you can create an issue and discuss it with us.
+
+## Running SDK in the development mode
+
+We use yarn as a package manager.
+
+1. First install the dependencies
+
+```bash
+yarn install
+```
+
+2. Then run the SDK in development mode
+
+```bash
+yarn dev
+```