Skip to content

Commit 554a14f

Browse files
committed
Update root home page, book landing
1 parent bf39ba2 commit 554a14f

4 files changed

Lines changed: 573 additions & 112 deletions

File tree

Lines changed: 248 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,248 @@
1+
---
2+
title: "Docs-as-Code Quick Start Guide"
3+
layout: learn
4+
image:
5+
path: /images/learn/mikecogh-trains.jpg
6+
thumbnail: /images/learn/github-logo400x200.png
7+
caption: "Photo from [Flickr:mikecogh](https://flic.kr/p/pEn3RB)"
8+
---
9+
10+
# Docs-as-Code Quick Start Guide
11+
12+
**Build Your First Modern Documentation Workflow Using GitHub, Markdown, and Automation**
13+
14+
---
15+
16+
## Introduction: Why Documentation Feels Broken
17+
18+
If you’ve worked in documentation, you’ve probably experienced this:
19+
20+
* Content lives in Word docs, wikis, or scattered tools
21+
* Developers don’t contribute—or avoid docs entirely
22+
* Publishing updates is slow and manual
23+
* Documentation quickly becomes outdated
24+
25+
The result? Frustration, inconsistency, and a constant feeling of playing catch-up.
26+
27+
There’s a better way.
28+
29+
---
30+
31+
## What Is Docs as Code?
32+
33+
**Docs as Code** is an approach where you create and manage documentation using the same tools and workflows as software development.
34+
35+
Instead of separate systems, you use:
36+
37+
* Version control (Git)
38+
* Plain text files (Markdown)
39+
* Collaborative workflows (pull requests)
40+
* Automated publishing (CI/CD)
41+
42+
This brings documentation into the same ecosystem as your engineering team—making it faster, more collaborative, and more scalable.
43+
44+
---
45+
46+
## What You Can Build with This Guide
47+
48+
In the next 20–30 minutes, you’ll:
49+
50+
* Create a documentation repository
51+
* Write content in Markdown
52+
* Make and review changes using pull requests
53+
* Understand how publishing can be automated
54+
55+
No advanced setup required—just a basic familiarity with Git concepts.
56+
57+
---
58+
59+
## Step 1: Create a Repository
60+
61+
Start by creating a new repository for your documentation, meaning a folder locally and a repository on a site like GitHub.
62+
63+
Suggested name:
64+
65+
```
66+
docs-example
67+
```
68+
69+
This repository holds all your documentation files.
70+
71+
### Why this matters
72+
73+
Storing documentation in a repository gives you:
74+
75+
* Version history
76+
* Collaboration via pull requests
77+
* A single source of truth
78+
79+
---
80+
81+
## Step 2: Add Your First Markdown File
82+
83+
Create a file called:
84+
85+
```
86+
index.md
87+
```
88+
89+
Add the following content:
90+
91+
```markdown
92+
# Welcome to Our Documentation
93+
94+
This is our first docs-as-code project.
95+
96+
## Getting Started
97+
98+
This documentation is written in Markdown and managed in Git.
99+
```
100+
101+
### Why Markdown?
102+
103+
Markdown is:
104+
105+
* Simple and readable
106+
* Easy to edit
107+
* Widely supported by documentation tools
108+
109+
It removes formatting friction so you can focus on content.
110+
111+
---
112+
113+
## Step 3: Make a Change Using a Pull Request
114+
115+
Instead of editing directly on the main branch, create a new branch:
116+
117+
```
118+
update-intro
119+
```
120+
121+
Edit your file:
122+
123+
```markdown
124+
This documentation is written in Markdown and managed in Git.
125+
126+
We use a docs-as-code workflow to collaborate and publish content.
127+
```
128+
129+
Now open a pull request.
130+
131+
### What’s happening here?
132+
133+
You’ve just:
134+
135+
* Proposed a change
136+
* Made it visible for review
137+
* Enabled collaboration
138+
139+
This is the core of docs-as-code.
140+
141+
---
142+
143+
## Step 4: Review and Collaborate
144+
145+
In a real team, someone would:
146+
147+
* Review your changes
148+
* Leave comments
149+
* Suggest improvements
150+
151+
This creates:
152+
153+
* Higher-quality documentation
154+
* Shared ownership
155+
* Better alignment with engineering
156+
157+
---
158+
159+
## Step 5: Merge and Publish
160+
161+
Once approved, merge the pull request.
162+
163+
At this point, your documentation is:
164+
165+
* Updated
166+
* Versioned
167+
* Ready to publish
168+
169+
---
170+
171+
## Step 6: (Optional) Add a Static Site Generator
172+
173+
To turn your Markdown into a website, you can use a static site generator like:
174+
175+
* Jekyll
176+
* Hugo
177+
* Sphinx
178+
179+
These tools:
180+
181+
* Convert Markdown into HTML
182+
* Apply themes and navigation
183+
* Create a professional documentation site
184+
185+
---
186+
187+
## Step 7: Automate Publishing
188+
189+
The final step is automation.
190+
191+
Using CI/CD, you can:
192+
193+
* Automatically build your site
194+
* Deploy it when changes are merged
195+
* Keep documentation always up to date
196+
197+
Now your workflow looks like this:
198+
199+
**Write → Review → Merge → Publish (automatically)**
200+
201+
---
202+
203+
## What You Just Achieved
204+
205+
In a short time, you’ve:
206+
207+
* Created a version-controlled documentation system
208+
* Collaborated using pull requests
209+
* Prepared content for automated publishing
210+
211+
This is the foundation of docs as code.
212+
213+
---
214+
215+
## Why This Changes Everything
216+
217+
Compared to traditional documentation, this approach:
218+
219+
* Reduces bottlenecks
220+
* Improves collaboration with developers
221+
* Enables faster updates
222+
* Scales across teams and products
223+
224+
Instead of being an afterthought, documentation becomes part of the development process.
225+
226+
---
227+
228+
## What’s Next
229+
230+
This quick start only scratches the surface.
231+
232+
In the full book, you’ll learn how to:
233+
234+
* Design scalable documentation architectures
235+
* Choose the right tools and platforms
236+
* Implement CI/CD pipelines for docs
237+
* Manage large documentation sets across teams
238+
* Build a sustainable docs-as-code culture
239+
240+
---
241+
242+
## Ready to Go Further?
243+
244+
If you found this useful, the full [book](https://docslikecode.com/book/) will take you from a simple workflow to a complete, production-ready documentation system.
245+
246+
👉 Continue your journey with *Docs Like Code*
247+
248+
---

0 commit comments

Comments
 (0)