low prio obv but i'm sad speckle guide doesn't have it 😿

IDK if you didn't want to list them in the Docs.

I was trying to copy Scope Boxes from one project to another and was provided a warning from Speckle connector that this was not possible.

Speckle team should determine if they want to list these items out on the Documentation of items not supported. The current list did not contain Scope Boxes and was rather vague.

https://speckle.guide/user/support-tables.html#non-supported-elements

Add sections and basic gotchas.

There are broken links to:

• https://speckle.guide/user/user/grasshopper.html#create-stream
• https://speckle.guide/user/user/grasshopper.html#get-stream
• https://speckle.guide/user/user/grasshopper.html#list-streams

Maybe these IDs existed before but have since been edited out.

We just added support for TIN surfaces in Autocad/Civil, so we should update the docs to reflect this.

specklesystems/speckle-sharp#1686

This issue is specifically intended as a no-code contribution for hacktoberfest:

• write one (or more!) comprehensive case studies on using Speckle on a project
• the case study can be in written form (blog post) or video

To submit: Make a PR to the repo readme with a link to what you have made.

NB: If you don't know how to create a PR to make this qualify as a contribution, let us know in the comments and we will do so for you! ✌

This issue is specifically intended as a no-code contribution for hacktoberfest:

Description

Create a model using your preferred choice of modelling software. This model will be used for internal tests and product demos.

⚠ Model must be created by you using the native software. So don't download a model from the web and upload it pls.

You can create a model of:

• 🗼 High-rise Tower
• 🏢 Commercial Architecture (store, showroom, bank)
• 🏠 Residential Architecture (Single-family, multi-family, apartment etc.)
• 🪑 Interior Design (House, Office, hotel, restaurant)
• 🏟 Stadium
• 🌳 Landscape Design
• 👡 Product Design
• 🏵 Pavilion

Examples of softwares you can use:

• Revit/Dynamo
• Archicad
• Sketchup
• Rhino/Grasshopper
• Blender

or any other modeling software Speckle has a connector for.

To submit

• Upload your model to any file hosting service (WeTransfer, Google Drive, Dropbox etc.)
• Make a PR to this repo readme with its link and a brief description of what it is
• OR just drop it here as a comment 💬

Note: Bonus points if you can also use the Speckle Connector for your authoring application and upload your model to a Speckle Stream!

NB: If you don't know how to create a PR to make this qualify as a contribution, just post it as a comment, and we will make the PR for you! ✌

eg:

• generally what it's used for (fallback value when no direct conversion exists) and how it's currently being used (web and converters)
• All non-geometry namespace objects should implement displayvalue, and some examples demonstrating type specification
• high level diagram clarifying when nested display values may be encountered (eg elements attached to revit builtelements)
• anything else that comes to mind

This issue is specifically intended as a no-code contribution for hacktoberfest:

• write one (or more!) comprehensive tutorial on using Speckle for a specific workflow or also about one of our features
• the tutorial can be in written form (blog post) or video

You can find one or more examples here:

• https://speckle.systems/tutorials/
• https://www.youtube.com/c/SpeckleSystems

To submit: Make a PR to the repo readme with a link to what you have made.

NB: If you don't know how to create a PR to make this qualify as a contribution, let us know in the comments, and we will do so for you! ✌

If you aren't already a Community member, do come and join us Speckle Community it can be a valuable sounding board for any proposed changes.

There's a new option to toggle between returning the output as the schema object, or as the main geometry with the schema stored in a property called @speckleSchema.

Add explanation and gifs to the docs.

What currently happens

Currently speckle.guide will default to serving over http:// protocol instead of https://.

Tested on Google Chrome on Mac OSX.

What I expected to see

speckle.guide defaulting to https:// protocol.

Asked (and possibly and possibly answered) in the forum:

https://speckle.community/t/grasshopper-notifications-for-updated-components/2221/3?u=alanrynne

TLDR

Deleting or modifying SchemaInfo constructors will delete the prior existing GH_Component, causing any files that used that component to stop working. We should document the way to actually do this properly to maintain backwards compatibility

• end user functionality and limitations
• developer endpoints etc?

This initiative is to follow the pattern established with the PowerBI revamp. Focussed on ease of use, finding, and sharing and breaking down monolithic content.

There's been quite some questions in the forum about Grasshopper->Revit workflows needing an applicationId to be set in Grasshopper for the update behaviour to work.

By default, Grasshopper does not add any applicationId since the objects are re-generated on every run, there is no consistent GUID we can use to refer to the same object in successive runs. Adding the applicationId to GH objects is left to the Grasshopper user.

Latest convo about this: https://speckle.community/t/add-a-revit-phase-parameter-with-extendspeckleobject-in-gh/4146/6?u=alanrynne

See: https://speckle.community/t/receiving-updated-geometry-creates-new-additional-geometry-and-how-to-commit-changes-only/2273

This issue is specifically intended as a no-code contribution for hacktoberfest, it could be any of the following:

• use compelling social media strategies to promote Speckle to a wide audiance
• write a blog post on Speckle
• organize a presentation on Speckle at your company
• organize a meetup
• if in doubt, just ask in the comments!

NB: If you don't know how to create a PR to make this qualify as a contribution, let us know in the comments and we will do so for you! ✌

Blender docs is missing a section on receive scripts, as implemented in this pr

There is no mention whatsoever of IFC in our docs or tutorials, wtf.

Add section in docs for Power BI to cover basics

Our JS docs section doesn't even mention or link to our npm packages, so it probably needs a good update!

How they work etc

To add some info here and references to npm packages: https://speckle.guide/dev/js.html

Hi,
I'm starting to use speckle on linux (mainly for QGIS, Blender and my scripts).

I saw that this discussion points to the instructions to add the account manually, but there's no indication of the path used in linux/unix systems.

After some lurking around the code I discovered that the folder is ~/.local/share/Speckle/Accounts

It would be great to add this path to the docs.

To add a section on support for BlenderBIM objects and IFC in general. What is supported and what not, how does it work?

Add a link to the decomposition api doc (https://speckle.guide/dev/decomposition.html) from the gh docs somewhere here: https://speckle.guide/user/grasshopper.html#detach-do-not-detach

Requires detailed documentation on how faces, vertices, etc all work. With examples on how to handle them ToSpeckle and ToNative.

This one of the more frequently asked questions on our forums

• https://speckle.community/t/object-geometry-mesh-faces-and-vertices-question/2913
• https://speckle.community/t/quads-v-triangles-from-rhino/2477
• https://speckle.community/t/mesh-face-formatting/646
• https://speckle.community/t/python-cube-created-in-py-not-showing-up-in-the-viewer/1901/6

Update docs and screenshots on DUI2.

This issue is specifically intended as a low-code contribution for hacktoberfest:

• noticed any missing sections in our docs?
• let us know in a comment, and if valid, it'll qualify as another contribution!

To submit: Make a PR to the repo readme with a link to what you have made.

NB: If you don't know how to create a PR to make this qualify as a contribution, let us know in the comments and we will do so for you! ✌

We should add user and dev docs to explain:

• our general approach to instances, definitions, and the transform class (eg what the transform matrix indicates for nested instances)
• expected data structure for block instances for rhino/acad/sketchup
• expected data structure for revit instances (and specifically, which family instances are sent as instances)

See https://speckle.community/t/speckle-object-keys-values-characters-not-allowed/1346/3

Since there are too many headers with the same text the indexing in algolia is failing

Might just be a matter of renaming them to Revit supported elements etc.

There is confusion around how webhook payloads are structured:

https://speckle.community/t/webhooks-json-response-has-the-entire-json-payload-as-a-string-value-on-the-key-payload/2452/2

We should describe the structure in the documentation, as the current documentation is misleading: https://speckle.guide/dev/server-webhooks.html#the-webhook-payload

eg:

• generally what it's used for (fallback value when no direct conversion exists) and how it's currently being used (web and converters)
• All non-geometry namespace objects should implement displayvalue, and some examples demonstrating type specification
• high level diagram clarifying when nested display values may be encountered (eg elements attached to revit builtelements)
• anything else that comes to mind

Problem description

Our documentation for deploying a server is to a VM (DigitalOcean droplet) with docker-compose.

Our preferred method of deploying is now to Kubernetes cluster with helm. This does not currently have a guide.

Acceptance criteria

given a user who wishes to deploy speckle server on kubernetes
when they look for documentation
then they can find a guide that is comparable to the existing guide.

Tasks

• Create a new guide
• Update Helm repository README
• update Helm repository Github pages README

We've had some issues recently around dependency problems between 2 versions of Core that turned out to be 3rd party plugins using our own libraries and packaging Core alongside with it.

Ideally, we'd create a page in the docs where we explain how to "deploy" your plugins that use Speckle in a way that won't break the default Speckle deployment in the process.

Link to writing custom Speckle apps on https://speckle.guide/dev/ is broken

Issue Description

Add Troubleshooting Section in the docs for Rhino connector toolbar issues.

When toolbar is added through Show or Hide Tabs option, it overwrites the .rui file so users stuck in the old buttons. Any new buttons added (such as Topography) won't show up even though its available in the command line.

Solution

Do not use Show or Hide Tabs to activate Speckle tab. Instead use Show Toolbar.

The FAQ and Core Concepts buttons could have a hover effect to make it more user-friendly.

If this seems to be a relevant issue can I work on it?