Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update front matters #257

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Update front matters #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions src/_guides/technical-writing/git-workflows-for-api-technical-writers.md
View file
Open in desktop
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
4 changes: 3 additions & 1 deletion ...ides/technical-writing/how-our-api-docs-can-ease-the-pain-of-api-deprecation.md
View file
Open in desktop
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
Loading