Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

title: Let's Treat Docs Like Code
locale: en-US
description: Technical documentation with tools and techniques like version control (GitHub) and automation (CICD) with static site generators (SSG) and more.
description:
logo: /images/treat-docs-like-code.png
#url: http://127.0.0.1:4000
url: https://www.docslikecode.com
Expand Down
30 changes: 30 additions & 0 deletions book/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,36 @@

[Docs as Code Quick Start Guide](/learn/000-docs-as-code-quick-start-guide/)


<div style="border: 2px solid #e0e0e0; border-radius: 8px; padding: 20px; margin: 20px 0; background-color: #f9f9f9;">
<h3>Peruse the table of contents</h3>
<b>Why treat docs as code?</b><br />
Discover the compelling reasons to apply software development practices to documentation, from faster iteration to better collaboration.
<br /><br />
<b>Background for docs as code</b><br />
Explore the evolution of documentation practices and how treating docs like code emerged as a solution to common industry challenges.
<br /><br />
<b>Plan for docs as code</b><br />
Learn how to assess your current documentation workflow and create a strategic roadmap for adopting docs-as-code practices.
<br /><br />
<b>Automate builds so you can focus on writing</b><br />
Set up automated publishing pipelines that handle the technical heavy lifting, freeing you to concentrate on creating great content.
<br /><br />
<b>Teamwork and GitHub workflows with docs-as-code systems</b><br />
Master collaborative workflows using GitHub's powerful features for pull requests, reviews, and team coordination on documentation projects.

Check warning on line 116 in book/index.md

View check run for this annotation

In Solidarity / Inclusive Language

Match Found

Please consider an alternative to `Master`. Possibilities include: `primary`, `main`, `leader`, `active`, `writer`
Raw output
/master/gi
<br /><br />
<b>Test the docs: linting, inclusive language, and DocOps</b><br />
Implement quality assurance through automated testing, accessibility checks, and continuous integration practices for documentation.
<br /><br />
<b>Review your docs as code</b><br />
Establish effective review processes that leverage code review best practices to ensure documentation accuracy and consistency.
<br /><br />
<b>Versions and releases: publish docs as code</b><br />
Manage documentation versions, releases, and deployment strategies that align with your software development lifecycle.
<br /><br />
<b>Lessons learned with docs as code</b><br />
Gain insights from real-world implementations, common pitfalls to avoid, and proven strategies for long-term success.
</div>
---

## Buy the Book
Expand Down
Binary file removed images/site-logo.png
Binary file not shown.
Binary file modified images/treat-docs-like-code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: home
title: "Docs Like Code — Treat Your Documentation Like a Developer"
title: "Docs Like Code──A modern approach to technical documentation"
excerpt: "Learn to write, version, automate, and ship technical docs using the same tools developers use: Git, GitHub, static site generators, and CI/CD."
search: false
show_excerpts: true
Expand Down