St. Jude Cloud Docs

Educational resources for the St. Jude Cloud project.

Explore the docs »

Request Feature
|
Report Bug

⭐ Consider starring the repo! ⭐

Quick Start

You can use the following commands to get started working with St. Jude Cloud docs.

```bash [Terminal]

pnpm install

pnpm dev
```

Development of the St. Jude Cloud Docs codebase is relatively simple.
Follow these guidelines to keep you between the rails 👍:

Use the commands in the quick start section to set up the code base, install dependencies, and run a development server.
This project enforces conventional commits using the conventional-changelog verbs.
A large chunk of automation is built off of this convention, so please follow it!
- Reading the above material is suggested, but not required for development.
- If, in practice, you use git cz (which calls [commitizen] underneath the hood) instead of git commit, then this will be taken care of.
  This is the suggested method for beginners.
- If you’re updating content (e.g. the documentation) and not source code, be sure to use the appropriate verb (e.g. use docs: for documentation upgrades).
The following integrations have been enabled or are in development. As such, you don’t need to do anything other than commit!
- Automated building with Nuxt and Nuxt UI 🧰.
- Automated versioning with conventional commits, conventional-changelog, and semantic-release 🗂.
- Automated production release and internal branch previews 🚀.
- Automated integration with Intercom for support questions in browser 💬.
- Automated spell checking 📚.
- Automated link validation 🔗.

With any issues you encounter with the repo, please file an issue report. For any other questions, please contact us at support@stjude.cloud.