Mastodawn

Lana Dec 7, 2024

Just wrapped up my talk at #APIdays Paris!
🚀 Built a wild GenAI tool that turns messy inputs into killer API docs using @Mistral + @HuggingFace.
Turning raw notes & specs into structured documentation? Yes, please.

🔗Demo: https://apidays-ai-novikova.netlify.app/documentation
🖥️ Slides: https://speakerdeck.com/lananovikova10/beyond-the-spec-bringing-context-to-life-with-genai-for-api-docs
📦 Code: https://github.com/lananovikova10/apidays-ai-poc
#AIDocumentation #APIDocs #generativeAI

API Documentation Generator

Generate API documentation using AI

Lana Nov 21, 2024

Spoke at the #WriteTheDocs meetup in Berlin yesterday, and it was an absolute pleasure connecting with so many like-minded folks! 🌟 We dove into emerging trends in the documentation world and how to stay ahead of the curve in the near future. 🚀✨ #TechWriting #Documentation #Writerside

Lana Sep 17, 2024

Excited to speak at the #OSSummit tomorrow! Today exploring the venue, attending talks and up for a chat about documentation in open source projects 💪🙌

Lana Sep 11, 2024

I'm excited to speak at Open Source Summit Europe 2024 soon — come to listen about documentation templates: is it a helpful aid, or sometimes they might be an overkill https://osseu2024.sched.com/event/77d9f9f9f39fc515b0d3ae22e9ceb7b6
@sched
#osssummit #thegooddocs #templates

Open Source Summit Europe 2024: Documentation Templates: A Helpful Aid o...

View more about this event at Open Source Summit Europe 2024

Lana Mar 5, 2024

Sometimes the delulu is real #memeday #techwritingmemes

Lana Feb 4, 2024

Show thread

lornajane Feb 3, 2024

Oh #FOSDEM ToolTheDocs DevRoom you are a delight, it is hot and very busy, and you were a gracious audience. If you’d like the slides for my DocOps in open source talk, you can find those here https://noti.st/lornajane/TVYAJ3/open-source-docops

Open Source DocOps by Lorna Jane Mitchell

Every software project has a robust continuous integration/delivery setup, but many of our documentation projects are still playing catchup. In this talk you’ll hear about a selection of tools that are good additions to your documentation pipeline, and how to use them both locally and in CI. We’ll cover linting and validation of your source content, and look at tools that can help with consistent formatting. We’ll also look at content quality tools, such as prose linting, link checking, and more. You’ll see examples of projects that use some or all of these tools in anger, and we’ll also discuss when too many tools is too many! This session is recommended for anyone who works on documentation platforms as either writer or engineer, and wants to make their world better.

Lana Feb 4, 2024

Fabrice Flore Feb 4, 2024

take time for #documentation is a high priority goal to have a long term successful project. Nice to hear @bagder . #fosdem2024

Lana Feb 3, 2024

Totally relate to this point by Jack Baldry, reading good docs is easy, writing docs that easy to read is damn hard #fosdem

Lana Feb 3, 2024

Erin McKean has made a perfect point - there are people who just want to have flowers in their home and others who will want to make their own vase. So some want to just publish their docs - 🌸 people, and some will dig deep to docops, customize, make their own pipeline -🏺people. BTW, I am considering myself a Vase person here, and you? I always need to dig into a low level and be able to customize stuff #fosdem

Lana Feb 3, 2024

Show thread

lornajane Feb 3, 2024

One talk done and the crowd were great. Slides for “Intro to OpenAPI” are here https://noti.st/lornajane/rBpMQe if you want to refer back to them! (Video coming probably tonight)

Introduction to OpenAPI by Lorna Jane Mitchell

OpenAPI Specification is a machine and human readable way to describe APIs, from endpoints to examples. From these descriptions we can generate documentation, create libraries, and ensure that our users know exactly what to expect from our APIs. This talk introduces you to the OpenAPI standard, showing how to describe APIs and looking at some popular API examples. Good tools are essential so we’ll look at some of the open source tools available to working with OpenAPI easier. We’ll cover the benefits of using an open standard to describe your APIs and discuss what you can do next, like publishing documentation, generating code, and teaching LLMs new tricks. Learn about what’s coming up in the world of OpenAPI, and how to get involved with this open standard and its community.