Skip to content

Commit

Permalink
Update front matters (bump-sh#257)
Browse files Browse the repository at this point in the history
Co-authored-by: Christophe Dujarric <[email protected]>
  • Loading branch information
2 people authored and paulRbr committed Jul 29, 2024
1 parent 8d7dcad commit e81d710
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Git Workflows for API Technical Writers
authors: james
canonical_url: https://bump.sh/blog/git-workflows-for-api-technical-writers
excerpt: Explore the challenges and solutions of keeping your docs in sync with an evolving API design using git workflows.
date: 2024-06-20
---

Technical writers are often challenged with keeping API documentation in sync with an ever-evolving API design. This article explores the challenges and solutions for tackling this ongoing struggle, focusing on parallel development and leveraging automation to streamline the process.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: How Our API Docs Can Ease the Pain of API Deprecation
authors: james
excerpt:
canonical_url: https://bump.sh/blog/how-our-api-docs-can-ease-the-pain-of-api-deprecation
excerpt: API become deprecated for a variety of reasons. Discover good practices to plan and communicate about deprecations, and minimize disruptions
date: 2024-07-04
---

APIs are not static, as new operations are added and existing operations are improved as API usage grows. As customer and business needs evolve, APIs need to adapt as well. This often leads to the inevitable process of API deprecation – the gradual phasing out of an old API in favor of a newer, improved version.
Expand Down

0 comments on commit e81d710

Please sign in to comment.