Skip to content

1. State of the art, project management and documentation

My documentation

For my projects, I use a combination of photos and concise descriptions to document the process thoroughly. These visuals and explanations serve as a clear record of the steps I take during development. To set up my project website, I use Gitlab as the interface. In Gitlab, we were provided with a demo website as a reference model to guide the customization of our own sites.

"No worries, you can't break anything, all the changes you make are saved under Version Control using GIT. This means that you have all the different versions of your page saved and available all the time in the Gitlab interface."

Documentation workflow

During my work on projects, I make a point to take multiple photos of each step in the process. This ensures I have a detailed visual record and can easily revisit specific steps to review the sequence or details of what I’ve done. This workflow helps me maintain clarity and precision in my documentation.


Step 1

This is the GitLab interface, showing the coding changes I made to personalize the website.

describe what you see in this image


Step 2

I customized the icon in the corner of the website, changing it to a lightning bolt.

describe what you see in this image

describe what you see in this image


Step 3

I updated the copyright section to reflect the necessary changes.

describe what you see in this image


Step 4

I modified the website’s color scheme to align with my design preferences.

describe what you see in this image

describe what you see in this image

weekly assignment

Check out the weekly assignment here or login to your NuEval progress and evaluation page.

Layout Examples

Header Examples

Text 1

Text 2

Text 3

Text 4

Text Examples

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

  • Text with Image

describe what you see in this image

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

describe what you see in this image

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

Images Examples

describe what you see in this image describe what you see in this image


Chart Examples

  • Chart 1
Test Subject 1 A male participant. Description Conductivity
1 Recipess - Glue stick 0 ohm Ω
1 Recipess - MOD Podge 0 ohm Ω
1 Recipess - Acrylic glaze 0 ohm Ω
1 Recipess - Acrylic paint 0 ohm Ω

  • Chart & Link 2
Qty Description Material Infill Notes
2 Link - PYMdown Extensions Documentation 0.57 g 30%
1 Link - PYMdown Extensions Documentation 11.41 g 30% Support
1 New Link - PYMdown Extensions Documentation 22.48 g 30%
2 Link - PYMdown Extensions Documentation 22.01 g 30% Glue Plate
2 Link - PYMdown Extensions Documentation 6.1 g 30%

  • Chart & images 3
Material pic Material name polymer plastifier filler emulsifier
bio-rainbow biokelp powder 12 gr glycerol 100 ml rainbow dust 1 kg green soap a drop
bio-rainbow biokelp powder 12 gr glycerol 100 ml rainbow dust 1 kg green soap a drop
bio-rainbow biokelp powder 12 gr glycerol 100 ml rainbow dust 1 kg green soap a drop
bio-rainbow biokelp powder 12 gr glycerol 100 ml rainbow dust 1 kg green soap a drop

Extra Examples

notes
  • In this updated version of the project, the primary changes involved the addition of two newly designed components: the motor pulley and the secondary pulley. These new parts were specifically created to enhance the system's functionality and improve overall performance.

The motor pulley was designed to attach directly to the motor's shaft, serving as the driving force behind the machine's movement. The secondary pulley was crafted to interface with the rollers, ensuring smooth and efficient power transfer throughout the system. Both pulleys were carefully modeled and 3D-printed to match the specific requirements of the project, including precise dimensions and compatibility with the existing components.

Aside from these new additions, the rest of the parts remained unchanged from the previous version. By keeping the original components intact and only introducing modifications where necessary, I was able to simplify the upgrade process while maintaining the machine's core design. These targeted adjustments helped optimize performance without overcomplicating the assembly, making the system more reliable and efficient in operation.


  • Slide Show

  • Video

-.

Code Example

Use the three backticks to separate code.

``` // the setup function runs once when you press reset or power the board void setup() { // initialize digital pin LED_BUILTIN as an output. pinMode(LED_BUILTIN, OUTPUT); }

// the loop function runs over and over again forever void loop() { digitalWrite(LED_BUILTIN, HIGH); // turn the LED on (HIGH is the voltage level) delay(1000); // wait for a second digitalWrite(LED_BUILTIN, LOW); // turn the LED off by making the voltage LOW delay(1000); // wait for a second }