Skip to content

Commit eb2d21a

Browse files
committed
docs: add descriptions to various documentation files for clarity and context
1 parent 9945bc2 commit eb2d21a

File tree

10 files changed

+37
-0
lines changed

10 files changed

+37
-0
lines changed

docs/ci-cd.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Automate testing and deployment with continuous integration and delivery pipelines.
3+
---
4+
15
# CI/CD
26

37
You know about CI/CD pipelines, but your current team does manual deployments. One person runs tests, builds the app, and pushes to production. It's slow but manageable for your small team. But as teams grow and deployment frequency increases, manual processes become too difficult and lead to mistakes. You realize that while manual deployments work for small teams, most professional environments expect automated pipelines.

docs/containerization.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Use Docker and containers to create consistent development and deployment environments.
3+
---
4+
15
# Containerization
26

37
You've heard about Docker and containers, but your current setup is simple—you develop locally and deploy to a single server that the DevOps person manages. It works fine for your current project. But as soon as you need to scale, work with multiple environments, or collaborate with larger teams, environment consistency becomes important. You realize that while you can avoid containers in simple environments, most modern development teams use them. It's time to learn containerization.

docs/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
sidebar_position: 1
33
slug: /
4+
description: Rebase your skills with modern software development practices.
45
---
56

67
# Getting Started

docs/git.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Learn Git workflows and collaboration practices used in professional development teams.
3+
---
4+
15
# Git
26

37
You know Git exists, you've even used basic commands, but your current team is small and everyone just pushes to main. No branches, no pull requests, no complex workflows. It works fine for your current project. But the moment you join a larger team or work on a more complex project, proper Git workflows become essential for preventing problems and maintaining code quality. You realize that while simple Git works for small teams, understanding proper Git workflows is essential for most professional development environments. It's time to master Git properly.

docs/global-communities.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Join tech communities to network, learn, and discover international opportunities.
3+
---
4+
15
# Global Communities
26

37
Building a successful tech career is not just about your technical skills—it's about connecting with the right communities that can guide you, support you, and open doors to opportunities you might never find on your own. By joining global tech communities, you gain access to resources that can help you grow professionally, find international opportunities, and connect with others who share similar experiences and goals.

docs/mentorship.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Find mentors and build relationships that accelerate your professional growth.
3+
---
4+
15
# Mentorship
26

37
You have worked hard on tutorials, built your own projects, and maybe even got your first job as a developer. But sometimes you face problems that are very hard to solve by yourself. Maybe you are confused about how to make big decisions in your code, how to grow in your career, or what to learn next. Having someone with more experience to guide you can really help. In today's fast-changing tech world, having a mentor is not just useful—it can be the difference between growing as a developer or feeling stuck and alone.

docs/observability.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Monitor and debug production applications using logging, metrics, and tracing.
3+
---
4+
15
# Observability
26

37
You've heard about monitoring, logging, and metrics, but your current application is simple enough that you can usually figure out problems by looking at the code or asking users what went wrong. But as your application serves more users and becomes more complex, debugging production issues without proper observability becomes nearly impossible. You realize that while you can manage simple applications without observability, most professional environments require it. It's time to make your applications observable.

docs/open-source.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Contribute to open source projects to build skills and connect with global developers.
3+
---
4+
15
# Open Source
26

37
Contributing to open source is one of the best ways to grow as a developer, build your reputation, and connect with developers around the world. Open source gives you a way to show your skills to international employers and build professional relationships across borders.

docs/testing.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Learn automated testing practices to write reliable code and catch bugs early.
3+
---
4+
15
# Testing
26

37
You've heard about unit tests, integration tests, and TDD, but your current company has a dedicated QA team that handles all testing. You write code, they test it, and that system works fine. But as applications grow more complex and teams move faster, relying only on manual testing becomes a bottleneck that slows everyone down. You realize that while you can rely on QA teams in some companies, most modern development roles expect you to test your own code. It's time to start testing your own code.

docs/web.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Understand how web applications communicate over networks and handle HTTP requests.
3+
---
4+
15
# Web
26

37
You've always focused on writing good code. You build beautiful components, create smooth user experiences, or develop clean APIs. Your current job keeps things simple: you build features, someone else handles deployment, and if there are network issues, the backend team deals with them.

0 commit comments

Comments
 (0)