👋 Welcome to the nBold documentation repository

ABSTRACT

This repository hosts the contents of the nBold Docs website.

🚀 CONTRIBUTE

Run locally

# Clone this repo
git clone https://github.com/nboldhq/docs.git
# Install dependencies
npm install
# Start VuePress in developer mode
npm run dev

CI/CD

Deployment is automated by the cicd GitHub Action:

1. Checkout the main branch when a push is detected
2. Build the static assets using the VuePress build command and commit changes
3. Push changes to the published branch
4. The website is deployed to Azure static website

Links check

After every push:

1. A check is done from the public website (from https://docs.nbold.co) to identify broken links using the Broken Link Checker module.
2. The result of this check is published as a new issue, automatically pinned to the top of the Issues page.

🆘 Support

See SUPPORT

📝 Contributing

See CONTRIBUTING

🛂 Code of Conduct

See CODE OF CONDUCT.

🔐 Security Policy

See SECURITY.

© License

See LICENSE.