Author, review, and publish Markdown and API docs with a Git-based docs-as-code workflow
Helsinki, Finland
Joined August 2020
- Tweets124
- Following15
- Followers65
- Likes23
Doctave retweeted
We're building a brand new editor for technical writing and docs-as-code at @GetDoctave!
We're pushing the boundaries of what an editor for documentation and technical writing professionals could look like.
Interested? Join the waitlist! Link below 👇
ALT A screenshot of Doctave Studio 2.0: Doctave's upcoming editor for technical writing and docs-as-code.
Doctave retweeted
I had the pleasure of chatting with Manny Silva about his work on VerbaGPT, and how he uses LLMs to cut his time-to-first-draft from 2 days to an incredible 5 minutes
Full conversation on YouTube 👇
youtu.be/fr-t0gMmrFk
Doctave retweeted
Granted @GetDoctave isn't a particularly data-heavy app, I feel like we just crossed some kind of milestone because we had to add a missing database index to address a performance issue.
Resulted in a good 150ms faster page loads for some customers!
Doctave retweeted
My discussion about Markdown and Structured Authoring with @remoquete is out!
We discussed lots of interesting ideas about how to bring structured authoring concepts into a docs-as-code context
Take a look!
youtube.com/watch?v=M5L0xyER…
Doctave retweeted
Your docs are the product.
For some companies, the docs are the biggest touch point that the your user will interact with. Much more important than the copy on your marketing site.
Invest in your docs, hire tech writers, make your users happy.
Doctave retweeted
Still think you should think twice about putting an AI in front of your carefully written developer docs.
Your users are not experts in your product. They cannot tell when the LLM is hallucinating and making up features, which it inevitably will (for now at least).
Doctave retweeted
@GetDoctave is amazing. The team is super approachable
Doctave retweeted
The @GetDoctave team is at @ApidaysHelsinki!
Come find us if you want to chat about API documentation 👀
Doctave retweeted
This is our biggest and most ambitious release to date! Excited to finally have it out in the world.
Doctave 2.0 is here! 🎉
This release brings with it...
- A brand new Markdown-aware component library for creating compelling and engaging articles
- An improved, customizable design, with the familiar Doctave layout
...and much more! We're excited to see what you build!
ALT The text "2.0" floating in a cloudy sky colored by a sunrise. Doctave's logo is monochrome in the top left corner against the clouds.
Doctave retweeted
Coming soon to @GetDoctave: custom components 👀
Create reusable widgets that can be rendered across your docs.
Mixing and matching our built-in layout components will let you build complex components without ever needing any custom CSS.
ALT A screenshot of code showing a custom Card component in Doctave's upcoming update. Here's the code itself: --- attributes: - title: heading required: true --- <Box p="3" class="custom-card-class"> **{ @heading }** <Slot /> </Box>
Doctave retweeted
Elixir powers large parts of @GetDoctave and has been rock solid.
Phoenix, especially with LiveView and Pubsub, is just a joy to use and simplifies our stack a lot.
Doctave retweeted
Having coded in #rustlang for so long has caused me to not tolerate bad error messages any more.
We're building a new component system in Doctave, and after much plumbing, we're finally getting the error messages to look 🤌
ALT An error message in Doctave showing an mismatched closing tag for a component. The opening tag is <Card>, but the closing tag is <Box>, and the error message draws arrows to both tags showing which tags caused the original error, along with a useful error message.
Doctave retweeted
So it's not actually just a component library...
As part of this component _engine_, we're also creating a small expression language!
The whole system is Markdown AST-aware, allowing us to do some really cool things.
Demos coming soon!
ALT A code screenshot showing an MDX-like Card component. It has an ":if" attribute with an expression checking if the reader's currently selected plan is "enterprise". Inside the card is some content that uses the same plan value and injects it into the Markdown itself.
We're designing a component library for @GetDoctave 👀
We'll have pre-built components out of the box, and you'll be able to combine lower-level components to build complex layouts and custom reusable components
Getting the level of abstraction right is an interesting exercise
Doctave retweeted
We're designing a component library for @GetDoctave 👀
We'll have pre-built components out of the box, and you'll be able to combine lower-level components to build complex layouts and custom reusable components
Getting the level of abstraction right is an interesting exercise
Doctave retweeted
Announcing a new thing! Dossier: github.com/Doctave/dossier
Dossier is a multi-language code and docstrings parser, powered by tree-sitter and written in #rustlang.
Give Dossier source code, and it outputs JSON that describes the functions/classes/etc along with their docstrings
Doctave retweeted
Great example of this phenomenon in this article posted on The Orange Website™ a few days ago: blog.orsinium.dev/posts/misc…
I can maybe get on board with some points regarding docstrings and code comments etc, but this just doesn't apply to e.g. developer portals.
Doctave retweeted
You can now add code samples to your API references directly from your OpenAPI spec!
Read the docs: docs.doctave.com/docs/conten…
Doctave retweeted
This kind of customer feedback makes working hard on a feature absolutely worth it 😎
ALT An email from a Doctave customer exclaiming how great the Doctave-rendered API reference documentation look after our latest update.
Doctave retweeted
The error rate on AI-powered documentation search is still remarkable. Anecdotally, I find issues almost every time I try them.
It's like talking to a support rep that makes stuff up 5-10% of the time. Not a good experience.
Doctave retweeted
Some devs on recent "orange website" threads seemed to discover that technical writers exist and questioned why.
Every company with great dev docs (Stripe, Twilio, etc.) has tech writers. That's why they're great.
If you want great docs, hire pros, and pay them well.
This Post is from an account that no longer exists. Learn more