Speckle Guide

Introduction

This is the home of Speckle.Guide - the home of our user guides and dev docs. The guide is split into three sections:

• /user: practical guides for end users
• /dev: developer documentation
• /automate: guides for automating workflows with Speckle

Developing & Debugging

Requirements

• Node 18

Setup

This repo is a vuepress site. To get up and running, just run:

1. npm install
2. npm run dev

Contributing

If you would like to expand on any of the sections, please feel free! We are also particularly interested in use cases and examples. If you have a cool workflow or use case that you think would be helpful to the community, we'd be happy to have it in the guide!

Please make sure you read the contribution guidelines for an overview of the best practices we try to follow.

Community

The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!

License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.