https://github.com/dydxprotocol/v4-documentation
https://github.com/dydxprotocol/v4-documentation
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dydxprotocol/v4-documentation
- Owner: dydxprotocol
- License: other
- Created: 2023-08-29T16:20:34.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-21T20:17:37.000Z (over 1 year ago)
- Last Synced: 2025-03-21T21:23:52.297Z (over 1 year ago)
- Language: MDX
- Homepage: https://v4-teacher.vercel.app
- Size: 36.8 MB
- Stars: 13
- Watchers: 19
- Forks: 35
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-ccamel - dydxprotocol/v4-documentation - (MDX)
README
## Development
This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI.
```
pnpm install
pnpm dev
```
## Deploy Vocs on Vercel (Quick Guide)
You can easily deploy Vocs using [Vercel](https://vercel.com). Follow these simple steps:
* Go to your Vercel dashboard and click **Add New** > **Project**.
* Select **Import Git Repository** and choose your forked Vocs repository.
* In the **New Project** setup:
* Set **Framework Preset** to `Other`.
* Set the **Root Directory** to `.` (root directory).
* Click **Deploy**.
After deployment is complete, your Vocs instance will be live on your Vercel domain. 🎉
## Documentation Guidelines
1. **Adding Sections to the Table of Contents (TOC)**
To add new sections to the Table of Contents, update the configuration file `vocs.config.ts`. Make sure to modify the appropriate section of the config so that your new pages or sections appear correctly in the TOC.
2. **Pages Location**
All documentation pages are located in the `docs/pages` directory. Each page should be added there, following the structure defined in the TOC configuration.
3. **Types Location**
All types are stored in a separate folder: `docs/pages/types`. The types are used in tables of parameters for methods.
4. **Using the Template**
A predefined template is available and should be used as the basis for creating all new pages. This ensures consistency in structure and style throughout the documentation.
`docs/pages/templates/method.mdx`