How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Doctave Studio 2.0 Beta: The editor for technical writing and docs-as-code

calendar_today October 8, 2024 person domain doctave

We’re excited to announce that Doctave Studio 2.0 is now available in public beta! Doctave Studio is a new editor for technical writing and docs-as-code, and we’re excited to share it with you.

Want to see it in action? Here’s a quick introductory video of Doctave Studio 2.0:

If you just want to see how to participate in the beta, you can jump straight to the end of this post

Why build a new editor?

One of the biggest issues with docs-as-code is inconsistent tooling. While there are great tools out there (like Vale), it’s really hard to create a great authoring environment for docs-as-code. Getting spell check, broken links checking, auto-complete, and more configured is often too complex or time consuming, that lots of authors live without these tools.

This problem is compounded when you have multiple authors collaborating on the same documentation. One will have a spell checker configured, one will have auto-complete configured, another doesn’t have a broken links checker. The lack of a common authoring system causes friction, confusion, and ultimately raises the barrier for contributions.

And after all that, you still need to set up these same checks in your CI/CD pipeline!

This is what we set out to solve with Doctave Studio 2.0.

We’ve already made it easy to host, version, and review docs-as-code projects with our existing product. Now we’re taking the next logical step and improving the docs-as-code authoring experience.

What’s in the Doctave Studio 2.0 beta?

Today we’re launching Doctave Studio 2.0 into beta with a few key features:

  • A new, modern editor with a focus on the authoring experience
  • Real-time previews of your content as you type (Markdown and OpenAPI!)
  • Powerful auto-complete for your links, assets, and components
  • Great error-reporting inline in your Markdown

Let’s see some of these in action!

Real-time previews

The right-side panel in Doctave Studio is dedicated to a real-time preview window. It shows you what your content will look like once published, and it’s updated in real-time as you make changes.

open_in_new Read original post