Preston MayiekaforfreeCodeCampfreecodecamp.org·Oct 23, 2024How to Automate Documentation Conversion with Pandoc in CI/CD PipelinesIn any software project, documentation plays a crucial role in guiding developers, users, and stakeholders through the project's features and functionalities. As projects grow and evolve, managing documentation across various formats—whether it’s mar...Discussdocumentation
Haimantika MitraforHashnode Town Halltownhall.hashnode.com·Oct 21, 2024Hashnode docs free license for open source projectsWe have recently launched Docs by Hashnode - the content engine for your API documentation and product guides. We've heard your pain points: Slow builds Complex setups Rigid systems Poor developer experiences And we're tackling them head-on. Yo...DiscussOpen Source
Rory Murphyapidna.hashnode.dev·Oct 18, 2024API Documentation Simplified: Using AI for Smarter AutomationAPI documentation is the roadmap for developers looking to effectively interact with and integrate APIs into their systems. It includes critical details such as endpoint descriptions, parameters, request and response examples, and error codes. Its ...DiscussAPIs
Ragavi S Pragavi.hashnode.dev·Oct 18, 2024Calling all Technical Writers!We're running a quick survey to gather your insights on the evolving role of technical writers and the impact of AI on the way we work. Your voice matters, and we’d love to hear from you! What's in it for you? Share your thoughts on how AI is transf...DiscussTechnical writing
Josep Projohomo.hashnode.dev·Oct 16, 2024From Zero to Hero: Game-Changing Documentation TipsIn a previous article, we discussed Design by Contract and how high-quality API documentation can greatly enhance understanding and improve user productivity. Let's quickly explore some of the most overlooked resources that programmers often miss, an...Discuss·3 likesdocumentation
Utkarshblogs.utkarshrajput.com·Oct 14, 2024Document you NodeJS APIs the best wayIntroduction As a Node.js developer, I’ve faced the same issue countless times: you build an awesome API with Express.js, it works great, and then… documentation. The excitement fizzles out. Let’s be real, no one loves documenting APIs, but we all ap...Discussdocumentation
Tina Hollyblog.tinaciousdesign.com·Oct 14, 2024Open API (Part 3): Generating an OpenAPI spec file from codeOverview This is the 3rd article in a series of posts about working with Open API to create generated API clients and documentation websites. In the 1st post we went over what we can do with Open API spec files, e.g. generate API clients and documen...Discuss·65 readsOpenApi
Buzzpybuzzpy.hashnode.dev·Oct 11, 2024Introducing Handbooks for Tech: Documentation Got "Better"Hello beautiful developers! Being a developer, one of the most boring things I come across is reading Documentation for hours. Despite being the best source of information for using software, their monotony and complexity are sometimes unbearable. Th...Discuss·7 likesProgramming Blogs
Chisom UmaforfreeCodeCampfreecodecamp.org·Oct 9, 2024How to Build a Documentation Site using React and DocusarausHaving a properly designed and comprehensive documentation site is important for any project. But creating good documentation can be challenging, and problems like poor user onboarding experience and increased support tickets can become daily hassles...Discussdocusaurus
Victor Uzoagbavictoru.hashnode.dev·Oct 7, 2024Building a Custom Static Site Generator for Technical DocumentationIntroduction What is a Static Site Generator (SSG)? A Static Site Generator (SSG) is a tool that converts plain text files (like Markdown) into a complete static website. The output is a set of static HTML pages, which are fast to load and easy to ho...Discusstutorials
