🌐 Setting Up My Documentation Website – Where Do I Even Start?!
Week 01r machines…
It began with something much scarier.
“Set up your own documentation website.”
Wait… what?
Website?
Git?
MkDocs?
Terminal?
I just wanted to design things… not fight with the command line 😭
For a good few minutes, I just stared at my screen thinking:
“How does everyone already know this stuff??”
🧠 Phase 1 – Mild Panic
Suddenly there were too many new words: - Python - pip - MkDocs - Git - SSH - GitLab - VS Code
It felt less like Fab Academy and more like: Fab Academy: The Software Edition™
At that moment, nothing made sense.
🔍 Phase 2 – Okay… Let’s Break It Down
Instead of panicking, I decided to treat it like a design problem.
One step at a time.
If a website is needed, then: - I need a tool to write → VS Code - a system to build → MkDocs - something to run it → Python - something to upload → Git - something to host → GitLab
Suddenly… it didn’t feel impossible anymore.
Just a checklist.
☕ Phase 3 – Deep Dive Mode
I spent hours: - watching Fab Academy recitations - checking documentation - reading forums - trying commands - breaking things - fixing them again
Half the time I didn’t know what I was typing. The other half I was praying it wouldn’t crash my laptop 😂
But slowly… things started working.
First Python. Then MkDocs. Then Git. Then the website finally opened in the browser.
That tiny moment when localhost:8000 actually loaded my page?
Pure happiness.
It felt like:
“Okay… maybe I can do this.”
🚀 The Actual Setup Process
After a lot of trial, errors, and fixes, here’s the step-by-step process I followed to set up my complete documentation workflow.
Week 01 – Software Setup & Documentation Workflow
🎯 Objective
The goal of this week was to set up my complete documentation environment for Fab Academy.
Before starting any design or fabrication work, I needed a proper workflow to: - write documentation - preview it locally - manage versions - publish online through GitLab
This required installing Python, MkDocs, VS Code, Git, and configuring SSH authentication.
Initially, the number of tools felt overwhelming, but setting them up step-by-step helped me understand how everything connects.
🔹 Step 1 – Installing Python
MkDocs runs on Python, so installing Python was the first requirement.
I downloaded the latest Python version and completed the installation. During setup, I enabled “Add Python to PATH”, which allows Python to be recognized from the terminal.
Without enabling PATH, commands would not work globally.
🔹 Step 2 – Verifying Python and pip
After installation, I verified whether Python and pip were properly installed.
This step is important because pip is used to install MkDocs and other packages.
The terminal successfully detected Python and pip, confirming the installation.
🔹 Step 3 – Installing MkDocs
Next, I installed MkDocs, which converts markdown files into a static website.
This tool simplifies documentation because I don’t need to write HTML or CSS manually.
After installation, MkDocs was recognized by the system, and I was able to use it from the terminal.
🔹 Step 4 – Installing Visual Studio Code
To edit files and manage my project efficiently, I installed Visual Studio Code.
VS Code provides: - markdown editing - integrated terminal - Git integration - file explorer
These features make it ideal for documentation work.
After launching it for the first time, I explored the interface and basic tools.
🔹 Step 5 – Installing Git
Git is necessary to track changes and upload files to GitLab.
During installation, I selected recommended default settings.
Git allows: - saving versions - committing changes - pushing updates online - collaborating easily
🔹 Step 6 – Configuring Git Terminal Preferences
While installing Git, I configured how Git interacts with the terminal.
I chose the Windows default console, since I was already comfortable using PowerShell and VS Code terminal.
This ensures Git commands run smoothly inside VS Code.
🔹 Step 7 – Selecting Default Editor
Git asked me to select a default editor for writing commit messages.
This is used whenever Git needs text input.
I selected a comfortable option that integrates well with my workflow.
🔹 Step 8 – Generating SSH Key
To securely connect my system with GitLab, I generated an SSH key.
SSH allows password-free authentication and is more secure than using login credentials repeatedly.
A public and private key pair was created and stored in my system.
🔹 Step 9 – Adding SSH Key to GitLab
I copied the public key and added it to my GitLab account.
This step links my laptop to GitLab and allows direct push/pull operations.
After adding the key, my device was successfully authenticated.
🔹 Step 10 – Authorizing VS Code with GitLab
I logged into GitLab through VS Code.
This enabled repository access directly inside the editor, allowing commits and pushes without switching tools.
🔹 Step 11 – Exploring VS Code Interface
Before proceeding, I familiarized myself with: - Explorer for files - Terminal for commands - Source Control for Git operations
Understanding these panels made the workflow much easier.
🔹 Step 12 – Git Identity Error (Problem Encountered)
While trying to commit for the first time, Git showed an error:
❌ "Author identity unknown"
Git could not detect my username and email.
This prevented commits from being created.
Solution
I configured: - username - email
After setting these, Git was able to recognize my identity and proceed normally.
🔹 Step 13 – Staging and Committing Files
After fixing the configuration, I staged my project files and committed them.
This saved my progress and created a version snapshot of my work.
The commit process now worked successfully.
🔹 Step 14 – Final Configuration Fix
During this stage, I encountered minor warnings related to Git configuration.
After reviewing and correcting the settings, the errors were resolved.
This helped me understand how Git tracks authorship and repository setup.
✅ Outcome
By the end of this week, I successfully:
✔ Installed Python
✔ Installed MkDocs
✔ Installed VS Code
✔ Installed Git
✔ Generated SSH keys
✔ Connected GitLab
✔ Fixed Git identity errors
✔ Created local documentation site
✔ Prepared workflow for publishing online
🧠 Reflection
This week helped me understand the technical backbone behind documentation.
Although the setup initially felt complex, solving each small issue improved my confidence.
I now clearly understand: - how local tools connect to GitLab - how version control works - how MkDocs builds websites - how documentation can be automated
This foundation will help me maintain structured and professional documentation throughout Fab Academy.