BlogRSS Feed

EasyPost

Improving Developer Usability and Experience With Refreshed, Modernized Documentation

by EasyPost
TweetShare

At EasyPost, we understand the importance of clean and efficient documentation. Having all the information you need, right where you need it, is critical for a smooth and quick integration process. 

That’s why, starting April 16, 2024, EasyPost will begin migrating to a new site for all API documentation. This new site will be easier to navigate, with new features such as a search bar, persistent coding languages for your session, and improved panel design. 

What can I expect from the new site?

We’re overhauling the structure we have today and rebuilding with you, the developer, in mind. Here’s what you can expect:

  • Quick links to all documentation, including our Guides, API Reference, Client Libraries, Carrier Guides, API Status, and Support pages.
  • Search bar functionality that will scan all headings and body copy so you can locate just about anything.
  • Customizable and persistent language. For any code block, you’ll be able to select your language from the dropdown menu. This setting will be remembered for your session, so you can pick up right where you left off.
  • Real-time table of contents for each guide, allowing you to quickly scan and jump to the section you need.
  • Better code blocks and examples. We’ve overhauled the structure to best serve developers. It features a sleek and cool two-panel design, with explanations written in plain English on the left and handy code snippets on the right.

Check out our new documentation here!opens in new tab

What if I’m in the middle of integrating using the current documentation?

If you’re in the middle of an integration right now, fear not! Our current documentation will stay on our website unchanged until June 2024. We recommend that you continue building the integration you’re working on using the current documentation, as the new website may have shifted some of the content you’re already familiar with.

If you have any additional questions about this update, please feel free to contact your dedicated Customer Success Manager or our Support teamopens in new tab.