From 20b93d25d6942cfe708f2f9ab61d20e151b520dc Mon Sep 17 00:00:00 2001 From: Matteo Cominetti Date: Fri, 19 Feb 2021 18:37:10 +0000 Subject: [PATCH] docs: updates readmes with link to docs --- packages/frontend/README.md | 8 +++++++- packages/server/readme.md | 8 +++++++- packages/viewer/readme.md | 9 +++++++-- readme.md | 8 +++++++- 4 files changed, 28 insertions(+), 5 deletions(-) diff --git a/packages/frontend/README.md b/packages/frontend/README.md index cedc15026..77cb9fd1e 100644 --- a/packages/frontend/README.md +++ b/packages/frontend/README.md @@ -1,6 +1,6 @@ # The Speckle Frontend App -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) ## Disclaimer @@ -12,6 +12,12 @@ Notes: - In **production** mode, the Speckle Server will statically serve the frontend app from `/dist`. You will need to run `npm run build` to populate this folder. +## Documentation + +Comprehensive developer and user documentation can be found in our: + +#### 📚 [Speckle Docs website](https://speckle.guide/dev/) + ## Project setup The frontend now includes the viewer. Until we get to publish it as a separate module, there's a few extra steps: diff --git a/packages/server/readme.md b/packages/server/readme.md index b5079e2a0..eede704e3 100644 --- a/packages/server/readme.md +++ b/packages/server/readme.md @@ -1,6 +1,6 @@ # Speckle Server -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) #### Status @@ -10,6 +10,12 @@ We're working to stabilize the 2.0 API, and until then there will be breaking changes. +## Documentation + +Comprehensive developer and user documentation can be found in our: + +#### 📚 [Speckle Docs website](https://speckle.guide/dev/) + ## Introduction The Speckle Server is a node application tested against v12. To start it locally: diff --git a/packages/viewer/readme.md b/packages/viewer/readme.md index 23a9e72ed..09ca89415 100644 --- a/packages/viewer/readme.md +++ b/packages/viewer/readme.md @@ -1,11 +1,16 @@ # The Speckle Viewer -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) -[![Slack Invite](https://img.shields.io/badge/-slack-grey?style=flat-square&logo=slack)](https://speckle-works.slack.com/join/shared_invite/enQtNjY5Mzk2NTYxNTA4LTU4MWI5ZjdhMjFmMTIxZDIzOTAzMzRmMTZhY2QxMmM1ZjVmNzJmZGMzMDVlZmJjYWQxYWU0MWJkYmY3N2JjNGI) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) ## Disclaimer We're working to stabilize the 2.0 API, and until then there will be breaking changes. +## Documentation + +Comprehensive developer and user documentation can be found in our: + +#### 📚 [Speckle Docs website](https://speckle.guide/dev/) + ## Getting started Note, these are WIP instructions. For development purposes, to start a webpack live reload server run: diff --git a/readme.md b/readme.md index f3b72e711..d3075ae7f 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ # Speckle Web -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Discourse users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/www-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) +[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) #### Status @@ -28,6 +28,12 @@ The frontend is a static Vue app. The viewer is a [threejs](https://threejs.org/) extension that allows you to display data from Speckle. +## Documentation + +Comprehensive developer and user documentation can be found in our: + +#### 📚 [Speckle Docs website](https://speckle.guide/dev/) + ## Developing and Debugging To get started, first clone this repo. Check out the detailed instructions for each module in their respective folder (see links above).