Skip to content

Commit da504fa

Browse files
committed
Text update
1 parent 9ab36e6 commit da504fa

File tree

6 files changed

+16
-10
lines changed

6 files changed

+16
-10
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Pull requests are welcome. If you want to build the site yourself, to test your
1313

1414
We generate the API documentation with [docfx](https://dotnet.github.io/docfx/). The files are compiled and pushed manually. To update the docs, follow the next steps:
1515

16-
1) Install docfx v.2.59.0. You can find more information and the steps [here](https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html).
16+
1) Install docfx. You can find more information and the steps [here](https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html).
1717
2) Pull the files from this repo via git.
1818
3) Update/replace the `.dll` and `.xml` files in the `src` folder.
1919
4) Use the command prompt and nagivate to the folder of this repo.

docs/README.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ <h1 id="robot-components-api-documentation">Robot Components API Documentation</
7070
<h2 id="getting-started">Getting started</h2>
7171
<p>We generate the API documentation with <a href="https://dotnet.github.io/docfx/">docfx</a>. The files are compiled and pushed manually. To update the docs, follow the next steps:</p>
7272
<ol>
73-
<li>Install docfx v.2.59.0. You can find more information and the steps <a href="https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html">here</a>.</li>
73+
<li>Install docfx. You can find more information and the steps <a href="https://dotnet.github.io/docfx/tutorial/walkthrough/walkthrough_create_a_docfx_project.html">here</a>.</li>
7474
<li>Pull the files from this repo via git.</li>
7575
<li>Update/replace the <code>.dll</code> and <code>.xml</code> files in the <code>src</code> folder.</li>
7676
<li>Use the command prompt and nagivate to the folder of this repo.</li>

docs/examples/intro.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
<article class="content wrap" id="_content" data-uid="">
6969
<h1 id="introduction"><strong>Introduction</strong></h1>
7070

71-
<p>To this API documentation, two examples are added. Both examples generate the same RAPID code for the same use case. In the first example, the use of the API inside IronPython is demonstrated. The other example is written in the C# programming language. The IronPython and C# codes are also added to the collection with Grasshopper example files. In the example, the RAPID code is generated for a robot that follows a few curves on a free-formed surface. An image of the case is given below.</p>
71+
<p>The API documentation contains two examples that illustrate the same use case, generating RAPID code for a robot that follows curves on a free-formed surface. One example showcases the use of the API in IronPython, while the other is implemented in C#. Additionally, both IronPython and C# codes have been included in the Grasshopper example files collection. The corresponding image of the example is provided below.</p>
7272
<img src="https://github.com/RobotComponents/RobotComponents-API-Documentation/blob/master/examples/images/api_example.png?raw=true" alt="example">
7373
</article>
7474
</div>

docs/index.html

+5-3
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,18 @@ <h2 id="getting-started"><strong>Getting Started</strong></h2>
7878
<h2 id="overview-of-the-namespaces"><strong>Overview of the namespaces</strong></h2>
7979
<p>The Robot Components API consist out of the following main name spaces:</p>
8080
<p><strong>Actions:</strong> This namespace contains all the classes to generate the RAPID program code. These are the different declarations and instructions to create a RAPID program. In the visual interface of the Grasshopper pluging these classes and the objects that are generated from these classes are categorized as code generation. This namespace also includes the RAPID generator class.</p>
81+
<p><strong>Controllers:</strong> This namespace contains classes and methods to interact with ABB controllers in real time.</p>
8182
<p><strong>Definitions:</strong> This namespace contains all the classes to define robots and robot tools which are needed for simulation and code generation.</p>
8283
<p><strong>Kinematics:</strong> This namespace contains the inverse and forward kinematics class, and the path generator class.</p>
84+
<p><strong>Presets:</strong> This namespace contains the mechanical unit presets.</p>
8385
<p><strong>Utils:</strong> This namespace mainly contains helper methods that are used in te all other namespaces. Most of these methods are also used in the utility components in the visual interface of the Grasshopper plugin.</p>
8486
<h2 id="credits"><strong>Credits</strong></h2>
85-
<p>The plugin is an open source project initiated by the chair of <a href="https://www.uni-kassel.de/fb06/institute/architektur/fachgebiete/experimentelles-und-digitales-entwerfen-und-konstruieren/home">Experimental and Digital Design and Construction</a> of the University of Kassel. The technical development is executed by the developers and contributors who are listed <a href="https://github.com/RobotComponents/RobotComponents/blob/master/AUTHORS.md">here</a>.</p>
86-
<p>RobotComponents uses the ABB PC SDK for real-time connection to ABB Robots, you can find the .dll used in this project here: <a href="http://developercenter.robotstudio.com/landing">ABB developercenter</a>.</p>
87+
<p>The plugin is an open source project initiated by the chair of <a href="https://www.uni-kassel.de/fb06/institute/architektur/fachgebiete/experimentelles-und-digitales-entwerfen-und-konstruieren/home">Experimental and Digital Design and Construction</a> of the University of Kassel. The technical development is executed by the developers and contributors who are listed <a href="https://github.com/RobotComponents/RobotComponents/blob/main/AUTHORS.md">here</a>.</p>
88+
<p>RobotComponents uses the ABB PC SDK for real time connection to ABB Robots, you can find the .dll used in this project here: <a href="http://developercenter.robotstudio.com/landing">ABB developercenter</a>.</p>
8789
<p>We would like to acknowledge <a href="https://github.com/garciadelcastillo">Jose Luis Garcia del Castillo</a> and <a href="https://github.com/visose">Vicente Soler</a> for making their Grasshopper plugins <a href="https://github.com/RobotExMachina">RobotExMachina</a> and <a href="https://github.com/visose/Robots">Robots</a> available. Even our approach is different it was helpful for us to see how you implemented certain functionalities and approached certain issues.</p>
8890
<h2 id="license"><strong>License</strong></h2>
8991
<p>Robot Components</p>
90-
<p>Copyright (c) 2018-2023 <a href="https://github.com/RobotComponents/RobotComponents/blob/master/AUTHORS.md">The Robot Components authors and / or their affiliations</a></p>
92+
<p>Copyright (c) 2018-2023 <a href="https://github.com/RobotComponents/RobotComponents/blob/main/AUTHORS.md">The Robot Components authors and / or their affiliations</a></p>
9193
<p>Robot Components is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3.0 as published by the Free Software Foundation.</p>
9294
<p>Robot Components is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
9395
<p>You should have received a copy of the GNU Lesser General Public License along with Robot Components; If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>

examples/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# **Introduction**
22

3-
To this API documentation, two examples are added. Both examples generate the same RAPID code for the same use case. In the first example, the use of the API inside IronPython is demonstrated. The other example is written in the C# programming language. The IronPython and C# codes are also added to the collection with Grasshopper example files. In the example, the RAPID code is generated for a robot that follows a few curves on a free-formed surface. An image of the case is given below.
3+
The API documentation contains two examples that illustrate the same use case, generating RAPID code for a robot that follows curves on a free-formed surface. One example showcases the use of the API in IronPython, while the other is implemented in C#. Additionally, both IronPython and C# codes have been included in the Grasshopper example files collection. The corresponding image of the example is provided below.
44

55
<img src="https://github.com/RobotComponents/RobotComponents-API-Documentation/blob/master/examples/images/api_example.png?raw=true" alt="example">

index.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -22,25 +22,29 @@ The Robot Components API consist out of the following main name spaces:
2222

2323
**Actions:** This namespace contains all the classes to generate the RAPID program code. These are the different declarations and instructions to create a RAPID program. In the visual interface of the Grasshopper pluging these classes and the objects that are generated from these classes are categorized as code generation. This namespace also includes the RAPID generator class.
2424

25+
**Controllers:** This namespace contains classes and methods to interact with ABB controllers in real time.
26+
2527
**Definitions:** This namespace contains all the classes to define robots and robot tools which are needed for simulation and code generation.
2628

2729
**Kinematics:** This namespace contains the inverse and forward kinematics class, and the path generator class.
2830

31+
**Presets:** This namespace contains the mechanical unit presets.
32+
2933
**Utils:** This namespace mainly contains helper methods that are used in te all other namespaces. Most of these methods are also used in the utility components in the visual interface of the Grasshopper plugin.
3034

3135
## **Credits**
3236

33-
The plugin is an open source project initiated by the chair of [Experimental and Digital Design and Construction](https://www.uni-kassel.de/fb06/institute/architektur/fachgebiete/experimentelles-und-digitales-entwerfen-und-konstruieren/home) of the University of Kassel. The technical development is executed by the developers and contributors who are listed [here](https://github.com/RobotComponents/RobotComponents/blob/master/AUTHORS.md).
37+
The plugin is an open source project initiated by the chair of [Experimental and Digital Design and Construction](https://www.uni-kassel.de/fb06/institute/architektur/fachgebiete/experimentelles-und-digitales-entwerfen-und-konstruieren/home) of the University of Kassel. The technical development is executed by the developers and contributors who are listed [here](https://github.com/RobotComponents/RobotComponents/blob/main/AUTHORS.md).
3438

35-
RobotComponents uses the ABB PC SDK for real-time connection to ABB Robots, you can find the .dll used in this project here: [ABB developercenter](http://developercenter.robotstudio.com/landing).
39+
RobotComponents uses the ABB PC SDK for real time connection to ABB Robots, you can find the .dll used in this project here: [ABB developercenter](http://developercenter.robotstudio.com/landing).
3640

3741
We would like to acknowledge [Jose Luis Garcia del Castillo](https://github.com/garciadelcastillo) and [Vicente Soler](https://github.com/visose) for making their Grasshopper plugins [RobotExMachina](https://github.com/RobotExMachina) and [Robots](https://github.com/visose/Robots) available. Even our approach is different it was helpful for us to see how you implemented certain functionalities and approached certain issues.
3842

3943
## **License**
4044

4145
Robot Components
4246

43-
Copyright (c) 2018-2023 [The Robot Components authors and / or their affiliations](https://github.com/RobotComponents/RobotComponents/blob/master/AUTHORS.md)
47+
Copyright (c) 2018-2023 [The Robot Components authors and / or their affiliations](https://github.com/RobotComponents/RobotComponents/blob/main/AUTHORS.md)
4448

4549
Robot Components is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3.0 as published by the Free Software Foundation.
4650

0 commit comments

Comments
 (0)