https://github.com/0xsequence/docs
Docs (deprecated), see new link below
https://github.com/0xsequence/docs
Last synced: 18 days ago
JSON representation
Docs (deprecated), see new link below
- Host: GitHub
- URL: https://github.com/0xsequence/docs
- Owner: 0xsequence
- Archived: true
- Created: 2024-02-24T21:42:16.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T19:55:19.000Z (about 1 year ago)
- Last Synced: 2025-12-12T10:54:29.845Z (6 months ago)
- Language: TypeScript
- Homepage: https://github.com/0xsequence/docs-v3
- Size: 129 MB
- Stars: 14
- Watchers: 13
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
IMPORTANT: please make sure you install "git lfs" in order to use this repository.
This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI.
## Dev
1. Clone the repo and run `pnpm i` to install packages.
2. Run a local environment with `pnpm run dev`.
In order to run the authentication, if needed, you will need to setup a cors-anywhere docker instance in order to proxy the request to the Builder API:
```
docker run -d -p 8080:8080 --dns 1.1.1.1 --name cors-anywhere redocly/cors-anywhere
```
### Update openapi docs
When you update examples in any of the existing `docs/pages/api/**/examples.json` which updates openapi request/response
examples.
You have to run this command to propagate those changes to openapi document.
```
pnpm run update-examples
```
##
In production, we leverage github actions to deploy a workflow and deploy automatically to github pages via the build branch.
v2 docs of Sequence Stack