Firstly, I’d love to see the tutorials and other docs go into the same place, such that tutorials can docs can easily reference to each other and such that when you search the docs you also search the tutorials and you don’t have to remember whether you found something you learned in the past in a tutorial or in the docs.
Secondly, I’d love improved Grasshopper and Python docs. When it comes to computational design, I think there are two important scripting languages 1. Grasshopper for (attributed) geometry related stuff, and 2. Python for everything else. With these two scripting languages you can pretty much hack together / link up 90% of engineering workflow steps.
Grasshopper
At the moment it’s really complicated to wrap your head around the Speckle Object and Speckle Geometry concepts, and how to properly create them in Grasshopper, and there’s actually some little bugs in there I think: Making working with Speckle Objects in Grasshopper (more) intuitive. This is also strongly related to what @chrkong mentioned about displayValues, speckle_types, etc.
Python
-
I also love the FastAPI docs that @chrkong mentioned, and my first impression of the
Strawberry GraphQL docs is good, and the Streamlit documentation is also great I think.
-
I love Jupyter Book, because it allows you to create interactive, Executable Python Content
, and launch a Live Environment
such as a Binder Notebook or Google Colab:
Exercises Ch1 - Python for Civil Engineers (tudelft-citg.github.io)
I also like their GitHub Repo - Suggest edit - Open issue menu:
-
Today I also discovered Quarto, which I think looks slick and seems to work well with Python as well as JavaScript, because it integrates with Jupyter and Observable JS.
P.S. when it comes to Astro, there’s starlight.astro.build for building docs sites specifically.