diff --git a/_config.yml b/_config.yml index bdd51b7..259e5fd 100644 --- a/_config.yml +++ b/_config.yml @@ -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 diff --git a/book/index.md b/book/index.md index 6f2d6e2..f18accf 100644 --- a/book/index.md +++ b/book/index.md @@ -97,6 +97,36 @@ Want to see if it’s right for you? [Docs as Code Quick Start Guide](/learn/000-docs-as-code-quick-start-guide/) + +
+

Peruse the table of contents

+Why treat docs as code?
+Discover the compelling reasons to apply software development practices to documentation, from faster iteration to better collaboration. +

+Background for docs as code
+Explore the evolution of documentation practices and how treating docs like code emerged as a solution to common industry challenges. +

+Plan for docs as code
+Learn how to assess your current documentation workflow and create a strategic roadmap for adopting docs-as-code practices. +

+Automate builds so you can focus on writing
+Set up automated publishing pipelines that handle the technical heavy lifting, freeing you to concentrate on creating great content. +

+Teamwork and GitHub workflows with docs-as-code systems
+Master collaborative workflows using GitHub's powerful features for pull requests, reviews, and team coordination on documentation projects. +

+Test the docs: linting, inclusive language, and DocOps
+Implement quality assurance through automated testing, accessibility checks, and continuous integration practices for documentation. +

+Review your docs as code
+Establish effective review processes that leverage code review best practices to ensure documentation accuracy and consistency. +

+Versions and releases: publish docs as code
+Manage documentation versions, releases, and deployment strategies that align with your software development lifecycle. +

+Lessons learned with docs as code
+Gain insights from real-world implementations, common pitfalls to avoid, and proven strategies for long-term success. +
--- ## Buy the Book diff --git a/images/site-logo.png b/images/site-logo.png deleted file mode 100644 index 7d85d4d..0000000 Binary files a/images/site-logo.png and /dev/null differ diff --git a/images/treat-docs-like-code.png b/images/treat-docs-like-code.png index b870f7d..a2ba7cd 100644 Binary files a/images/treat-docs-like-code.png and b/images/treat-docs-like-code.png differ diff --git a/index.html b/index.html index 239e615..ecb71f4 100644 --- a/index.html +++ b/index.html @@ -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