From 494bd30d2e239f71c6a858ec3ffc9df736c110ee Mon Sep 17 00:00:00 2001 From: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> Date: Mon, 18 Apr 2022 16:50:10 +0900 Subject: [PATCH] Update company.md (#5185) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit • Updated a broken link. • Rephrased the sentence leading up to said link. --- handbook/company.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/handbook/company.md b/handbook/company.md index d02317e342..71acc7c736 100644 --- a/handbook/company.md +++ b/handbook/company.md @@ -239,7 +239,7 @@ We prefer to generate our REST API reference docs the good old-fashioned way. By - Markdown gives us more control over how the docs are compiled, what annotations we can include, and how we present the information to the end-user. - Markdown is more accessible. Anyone can edit Fleet's docs directly from our website without needing coding experience. -- A single Markdown file reduces surface area sprawl that comes from spreading code comments across multiple files throughout the codebase. (see ["Why do we use one repo?"](why-do-we-use-one-repo)). +- A single Markdown file reduces the amount of surface area to manage that comes from spreading code comments across multiple files throughout the codebase. (see ["Why do we use one repo?"](/company.md#why-do-we-use-one-repo)). - Generated docs can become just as outdated as handmade docs, except since they are generated, they become siloed and more difficult to edit. - Autogenerated docs are typically hosted on a subdomain. This means we have less control over a user's journey through our website and lose the SEO benefits of self-hosted documentation. - Autogenerating docs from code is not always the best way to make sure reference docs accurately reflect the API. Based on our experience from past projects, we've learned that the benefits of generated docs do not outweigh the drawbacks of creating them by hand.