Documenting REST APIs with OpenAPI docs (NestJS/Swagger)
OpenAPI is a language-agnostic specification for declaring API documentation for REST APIs. NestJS offers a Swagger plugin for producing the API docs. Setup Configure API documentation with the required endpoint, like /api-docs. const SWAGGER_API_ENDPOINT = ‘/api-docs’; // … export const setupApiDocs = (app: INestApplication): void => { const choices = new DocumentBuilder() .setTitle(SWAGGER_API_TITLE) .setDescription(SWAGGER_API_DESCRIPTION) .setVersion(SWAGGER_API_VERSION) […]
Arquitetura da Informação e Planejamento de Conteúdo para Sites de Documentação
Num artigo anterior desta série, vimos como configurar um web site dedicado de documentação com o gerador de websites estáticos Hugo, e como hospedá-lo gratuitamente na Netlify. Agora você deve estar se perguntando qual é a melhor maneira de organizar a sua documentação de uma forma que os usuários possam aproveitá-la da melhor maneira possível […]
Information Architecture and Content Planning for Documentation Websites
In a earlier article on this sequence, we have seen tips on how to arrange a devoted documentation web site with Hugo, and tips on how to host it free of charge on Netlify. Now it’s possible you’ll be asking your self what’s one of the simplest ways to prepare your documentation in order that […]
Como criar e hospedar um site de documentação para o seu projeto usando Hugo e Netlify
Introdução Num publish anterior dessa série, nós vimos dicas e boas práticas para criar um bom readme para o seu projeto, e como organizar um set inicial de docs para cobrir o básico. Manter a documentação junto ao códio fonte pode ser uma boa solução em muitos casos, mas dependendo do tamanho do seu projeto […]
We won best dev portal!
Yesterday the Fastly developer hub developer.fastly.com gained Finest Onboarding Expertise on the 2022 Dev Portal Awards! One of many jurors stated: They actually need to get you began quick and with out friction. Very properly completed, gives numerous useful assets. Testing choices that you should utilize instantly. One of many different feedback was my favorite […]
Documentation 101: creating a good README for your software project
Having a superb documentation in your open supply mission is a vital (and infrequently missed) characteristic to drive adoption and present the total potential of what customers can accomplish along with your utility or library. Sadly, documentation typically grows in a a lot slower price than code, primarily as a result of some implementations that […]
Contributing to docs! – DEV Community
Over the previous one yr I’ve achieved a LOT of documentation work. I impart a bit of data on this weblog! So let’s go –> Why contribute to docs. It is a gateway contribution in direction of open supply organizations. You acquire plenty of floor degree data about a company earlier than you already know […]
A importância de uma boa Documentação
Prólogo Uma das discussões mais recentes do nosso querido TwitterDev é sobre algo que eu, como criador de conteúdo e como pessoa que gosta de documentar ideias e projetos acho exagerado ter que escolher um dos extremos, onde: “sim é muito bom documente tudo” OU “não documente nada pois o código precisa ser legível”. No […]