up

Author: vanvianen

docs/guide/parameters.md

@@ -1,10 +1,29 @@
 # Parameters
 
 
+
+
+### Parameter Types
+
+Design Variables, or sometimes referred to as User Defined Variables, are those parameters that are crucial to the concept definition of the design. Often those parameters contain numerical inputs that are allowed to change during the design (and/or optimization). A parameter is a symbolic name often associated with a numerical value and which may be changed. Not all parameters are Design Variables but all Design Variables are parameters. Parameters could be constant. If this is the case, do not use sliders to define their values, but Set Numbers instead. Clearly label Design Variables.
+
+
+
+#### Input Parameters
+These are parameters that provide input values to a Grasshopper definition. Input parameters can be used to define the starting point for a design or to allow users to provide specific input values.
+
+#### Output Parameters
+These are parameters that provide output values from a Grasshopper definition. Output parameters can be used to display the results of a design or to provide data to other software applications.
+
+
+
+
+### Parameter Naming Conventions
+
 When naming design parameters in your Rhino Grasshopper scripts, it is important to use clear and descriptive names that accurately reflect the purpose of the parameter. 
 Using the following best practices, you can create more readable, understandable, and maintainable definitions in Rhino Grasshopper:
 
-#### 1. Meaningful Mames
+#### 1. Meaningful Names
 Always use descriptive and meaningful names: Use names that describe the purpose or function of the parameter. Avoid using vague or generic names that do not provide enough information about the parameter's role in the definition.
 
 2. Use consistent naming conventions: Use consistent naming conventions throughout your definition. This makes it easier to understand the relationships between different parameters and components.
@@ -21,11 +40,26 @@ Always use descriptive and meaningful names: Use names that describe the purpose
 
 
 
+
+### Parameter Type Conventions
+
+
+
+#### single
+
+'''
+(parameter)
+'''
+
+#### list
+
+'''
+[parameter]
+'''
+
 Design Variables and Parameters
 
 
-Different types of parameters
-Design Variables, or sometimes referred to as User Defined Variables, are those parameters that are crucial to the concept definition of the design. Often those parameters contain numerical inputs that are allowed to change during the design (and/or optimization). A parameter is a symbolic name often associated with a numerical value and which may be changed. Not all parameters are Design Variables but all Design Variables are parameters. Parameters could be constant. If this is the case, do not use sliders to define their values, but Set Numbers instead. Clearly label Design Variables.
 
 
 

docs/index.md

@@ -11,6 +11,16 @@
 
 **Starling Egg is a Grasshopper template geared towards project collaboration.**
 
+Starling Egg is a Grasshopper template that has been specifically designed for project collaboration. This template allows multiple designers to work together on a single Grasshopper definition, making it ideal for projects where a team-based approach is required.
+
+One of the key features of Starling Egg is its ability to manage version control. With this template, each designer can work on a separate branch of the Grasshopper definition, making changes and testing new ideas without affecting the work of other team members. Once a design element has been finalized, it can be merged back into the main branch of the definition, ensuring that all team members are working with the latest version of the design.
+
+Another important feature of Starling Egg is its ability to support communication and collaboration between team members. The template includes a range of tools for commenting on design elements, discussing design decisions, and sharing information with other team members. This makes it easier for team members to work together effectively, even if they are located in different parts of the world.
+
+In addition, Starling Egg includes a range of components that can be used to create complex geometries, define materials and textures, and generate detailed reports and documentation. These components are designed to be flexible and adaptable, so that they can be easily customized to meet the specific needs of a design project.
+
+Overall, Starling Egg is a powerful and flexible tool that can help design teams to work more efficiently and effectively. Whether you are working on a large-scale architectural project or a smaller design project, this template is sure to be a valuable asset in your design toolkit.
+
 ---
 
 **Starling Egg** consists of a reference document and a Rhino + Grasshopper template.
@@ -21,6 +31,19 @@ The Grasshopper Template is a part of every Grasshopper project. It guides the w
 
 ![Starling Egg](/assets/image/screenshots/starling_egg.png "Starling Egg")
 
+
+Starling Associates has developed a powerful Rhino Grasshopper template system that can help designers streamline their workflow and improve the quality of their designs. This template system includes a set of pre-built Grasshopper components that can be easily customized and adapted to fit the specific needs of a design project.
+
+The template system includes a variety of components that can be used to create complex geometries, apply materials and textures, define lighting and camera settings, and generate documentation and reports. The system is designed to be intuitive and easy to use, with a user-friendly interface that allows designers to quickly and easily navigate through the various components.
+
+One of the key features of the Starling Associates template system is its focus on modularity and flexibility. The components can be easily combined and reconfigured to create new designs, and they can be adapted to work with different types of input data and design parameters.
+
+Another important feature of the template system is its emphasis on sustainability and energy efficiency. The components include a range of tools and techniques for optimizing designs and reducing energy consumption, making it an ideal choice for architects, engineers, and designers who are committed to creating sustainable and environmentally-friendly designs.
+
+Overall, the Rhino Grasshopper template system developed by Starling Associates is a powerful and versatile tool that can help designers to create high-quality, innovative designs more efficiently and effectively. Whether you are working on a small-scale project or a large-scale architectural design, this template system is sure to be a valuable asset in your design toolkit.
+
+
+
 ---
 
 **Starling Egg** is an open-source project by [Starling Associates](https://www.starling.associates "Starling Associates website") and [Scape Agency](https://www.scape.agency "Scape Agency website").

docs/quick_start.md

@@ -1,4 +1,28 @@
 # Quick Start
 
 
-Download the template files from our repository.
+Starling Egg is a Grasshopper template that has been specifically designed for project collaboration. To get up and running follow these instructions:
+
+1. **Download** – Download the latest release of the Starling Egg template files from our repository.
+
+
+
+
+
+ The Starling Egg template can be downloaded from the Starling Associates website. Once you have downloaded the template, simply install it on your computer using the provided installer.
+
+Open the Starling Egg template in Grasshopper: Once the template has been installed, open it in Grasshopper. You should see a range of components and tools that have been specifically designed for project collaboration.
+
+Familiarize yourself with the interface: Take some time to explore the interface and get familiar with the different components and tools that are available. You'll find tools for version control, commenting, and sharing information with other team members.
+
+Set up your team: Before you start working on a project, you'll need to set up your team. This can be done using the team management tools included in the template. You can add team members, assign roles, and set up permissions to ensure that everyone has the right level of access to the project.
+
+Start collaborating: Once your team is set up, you can start collaborating on your project. Use the commenting tools to discuss design decisions, share information, and provide feedback. Use the version control tools to manage different branches of the Grasshopper definition, and merge changes back into the main branch once they have been finalized.
+
+Customize the template to fit your needs: The Starling Egg template is designed to be flexible and adaptable, so you can customize it to fit the specific needs of your project. You can add new components, modify existing ones, and create your own tools and workflows.
+
+By following these simple steps, you can start using the Starling Egg template to collaborate more effectively on your next design project. With its powerful set of tools and flexible interface, this template is sure to be a valuable asset in your design toolkit.
+
+
+
+