https://github.com/cyscale/docs.cyscale.com
Cyscale Developer Portal
https://github.com/cyscale/docs.cyscale.com
Last synced: 5 months ago
JSON representation
Cyscale Developer Portal
- Host: GitHub
- URL: https://github.com/cyscale/docs.cyscale.com
- Owner: cyscale
- License: mit
- Created: 2020-04-29T09:34:10.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-07-09T13:02:03.000Z (11 months ago)
- Last Synced: 2025-07-09T14:19:54.147Z (11 months ago)
- Language: JavaScript
- Homepage: https://docs.cyscale.com
- Size: 17 MB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security/_category_.json
Awesome Lists containing this project
README
# Cyscale Docs
This repo contains [docs.cyscale.com](https://docs.cyscale.com/). It is built with [Docusaurus](https://docusaurus.io/).
## Contributing to the Docs
First of all, this is all markdown. You might want to write the content in a dedicated word processor (e.g. on [Confluence](https://cyscale.atlassian.net/wiki/spaces/DOC/overview)) and, once you are happy with the content (the text is correct), copy it in the docs directory, in the corresponding file. Docusaurus generates the website with the structure following the directory structure.
To run the docs locally, you will need [Node.js](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/getting-started/install). Run `yarn` to install the dependencies and `yarn start` to serve the website locally.
## Deployment
GitHub actions handle the entire deployment process. Currently, we host the docs on [GitHub Pages](https://pages.github.com/).