Giter VIP home page Giter VIP logo

speckle-docs-old's Introduction

Speckle Guide

Twitter Follow Discourse users website

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

Developing & Debugging

This repo is a vuepress site. To get up and running, just run npm run dev or yarn 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.

speckle-docs-old's People

Contributors

alanrynne avatar amole-arup avatar clairekuang avatar cristi8 avatar daviddekoning avatar didimitrie avatar izzylys avatar messismore avatar oliveregreen avatar simplynail avatar teocomi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

speckle-docs-old's Issues

iframe and viewer docs

To create docs that explain how to use the viewer and add a paragraph that explains how to use iframe embedding.
Also:

  • blog post aboutiframe
  • forum post on iframe

Docs: Revit to Gh and back v2

Qualms:

  • we can’t even see the revit model
  • focus on data processing down the line
  • Simple example (for now): colour the model by a revit property of choice (ie, volume; family name and type, etc)
  • Complex example (for later if difficult): analysis of sorts and change revit model based on results (eg karamba, or some isovist analysis, or any other practical application) by using the new UpdateParam schema builder component

Unreal Docs Page

The internal show and tell @cristi8 did in a markdown format with some quick screenshots.

Basically guide users through:

  • cloning the project
  • setting it up in unreal
  • importing their first stream
    • creating a personal access token
    • pasting in server url, etc.

New tutorials

New tutorials for a generic audience:

  • Collaborative Grasshopper & Rhino Workflows
  • Using speckle for version control
  • Rhino > Revit in progress
  • Acad /Civil > do something?

Tutorials for computational designers:

  • Google sheets & Airtable (?)
  • PowerBI (?)
  • Revit > GH in progress
  • GH > Revit in progress

Tutorials for devs:

  • Python Dashboard
  • Using Docker to deploy a local server
  • Simple speckle apps:
    • One backend (nodejs+express)
    • One frontend only
  • Serverless function example?
  • Writing a .NET connector from scratch
  • Writing a .NET data extractor for an app
  • Real Time Revit Stuff from Unity
  • additional “examples/scripting” sections under each SDK

Docs: Rhino to Revit v2

Model:

  • start from a cool model, end with a cooler model
  • show our tools for what they are valuable: eg parametric facades etc
  • I've had a stab at creating a Leadenhall clone you can use as a base (source gh &rh here)

Main quirks: show almost all supported flows:

  • walls
  • floors
  • columns & beams
  • etc.

General notes:

  • Show rhino/gh and revit side by side updating in real time (where applicable)
  • Animations (mp4s -> gifs) should be compelling (think: marketing ready)

WIP: Docs polish

Zero To Speckle:

  • visual programming -> Grasshopper & Dynamo (Also feel like they should be headings that are visible in the sidebar)
  • images missing for gh/dyn
  • coming soon link links to self, should link to join the beta

Grasshopper & Dynamo guides:

  • no info around behaviour of receive nodes: receive a stream; receive a branch; receive a commit; receive a single object; + auto receive

  • sending data section: it makes things more difficult than they should be; only a tiny remark on "url"; needs better defintion; how do i send to a branch? commit message?

Speckle web:

  • images are outdated, some critically so

Revit, Rhino, Acad sections:

  • emphasise with a ::: tip the "read the ui section first" part

Connectors introduction

  • feels like it needs some big links in the main text body

Speckle manager:

  • remove link for mac as it's not helpful
  • adding accounts needs a smol update to say you can update from the onboarding in the webz

Improve search

Vuepress allows for external search engines/plugins etc

How to get started with Gh video

Keep it short and sweet (1-2mins max). Steps to include:

  • installation
  • sending data data out
  • view sent data in online viewer
  • receiving data

How to get started with the blender connector video

Quick video on how to get started with the blender connector to embed in the docs.

Keep it short and sweet (1-2mins max). Steps to include:

  • installation
  • sending data data out
  • view sent data in online viewer
  • receiving data

Speckle purpose/roadmap

What is the exact purpose of speckle? What is it supposed to do and is just not implemented yet and what is it not supposed to do?
I think this fundamental information is very important for anyone starting with speckle and even after quite a bit of digging I haven't found answers.
I got speckle running in blender and it looks great what I still don't know is:
Is speckle able to stream data between different supported software? So can I download the stream I created in blender to grasshopper?
I see that only geometry is supported in blender right now. So does speckle do geometry only? Or will it some day support modifiers and transformation and all the other Data present in a blender object?
People at Osarch.org are developing a BIM add-on form blender, it would be amazing to be able to share the whole bim model from blender through speckle, but is it even its intended use?

🏄‍♂️ User Guide: Dynamo, Grasshopper, and a bit of Web

Alan is working on general guides for the aforementioned sections, so he has kindly offered to dump these into our lovely user guide when he is finished.

currently, these live in /user/connectors.md but they might get broken out into their own files depending on how it's lookin

Beautify & structure docs

This docs website is empty and unstyled, we need to beautify and give it some preliminary structure!
Structure suggestion:

  • intro
    • user docs
      • getting started
      • manager & accounts
      • connectors
      • web app
    • dev docs
      • ...

Chunking

Add a section on chunking inside the decomposition page.

Docs: Gh to Revit v2

Model:

  • start from a cool model, end with a cooler model
  • show our tools for what they are valuable: eg parametric facades etc
  • I've had a stab at creating a Leadenhall clone you can use as a base (source gh &rh here)

Show almost all supported flows and their quirks:

  • reusing existing levels
  • creating new levels
  • Creating adaptive components
  • direct shapes by category
  • difference between Revit objects and Speckle objects in schema builder
  • updating things, how and when it works
  • breps etc

General notes:

  • Show rhino/gh and revit side by side updating in real time (where applicable)
  • Animations (mp4s -> gifs) should be compelling (think: marketing ready)

Dev docs - server rest api

For people who can't use the SDKs (different language, etc), it would be useful to document the REST API of the server

Acad /Civil Tutorial

Tutorial that shows the Acad /Civil in use, potentially:

  • to/from GH
  • to/from Rhino

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.