At Ditto, our developer integrations (API/CLI, SDKs, and more) are core to our product. They enable teams to keep text in development up-to-date, build automated workflows, and create integrations with existing tools — so that Ditto can serve as a single source of truth for their product text, from design to development. This makes our developer documentation a core aspect of our product as well.
Over the last few months, we overhauled our developer-facing documentation, guides, and example repos, with the intent of showcasing everything developers need to not only get started with Ditto’s developer integrations, but to build Ditto into their workflows at scale.
Today, we’ve released our new developer docs. 🎉
In the new docs, we tackle explaining both how Ditto works in the big picture and how to solve specific use-cases with concrete examples. This included answering common questions like:
In addition, here are some of the changes (both big and small) we’re most excited to introduce:
You can now test API endpoints to return data from your own workspace — directly in the API docs themselves. Just provide an API key, and you can quickly get up and running to test and validate the responses of API endpoints relevant to your team’s workflow.
Additionally, with the Ditto CLI mirroring what’s returned by Ditto API endpoints , you can test the endpoints to determine the specific data and formats you want to fetch in a CLI workflow.
We’ve revamped our example apps to connect with the Ditto sample project and components that come pre-loaded in your workspace. This means you can duplicate our sample repos to spin up a functioning React, iOS, or Android application and connect it to Ditto (and design files!) in less than 5 minutes.
We’re excited about the independence this gives to developers ramping up to Ditto, allowing them to immediately explore a full end-to-end Ditto workflow in local development without waiting on non-developers to set up work in Ditto.
We’ve introduced the Key Concepts page, where we cover core Ditto concepts (components, variants, variables, developer IDs, and more) as they apply to what a developer can utilize day-to-day. On this page, we connect these concepts to common developer use cases for strings: text reuse, translation, interpolating dynamic text, pluralization, and more.
Just as our Help Guides explain generalized use cases for Ditto concepts, we hope this developer-oriented overview helps contextualize Ditto features to showcase how they get used in real codebases. Regardless of whether these features get set up in-app by developers or non-developers, how text is structured in-app is integral to how it’s able to be fetched by Ditto’s developer integrations.
We’re so excited for developers building with Ditto to give our new docs a spin.
If you’re a designer or writer hoping to extend Ditto’s functionality on your team to sync edits into development, feel free to share our new docs with a developer!
In addition to rewriting all of our documentation, we’ve also rolled out some exciting new developer-side functionality — including webhooks, out-of-the-box iOS / XCode localization compatibility, updated CLI configuration properties, and more.
Happy writing!
