Forem

# documentation

Improving and writing documentation

Posts

👋 Sign in for the ability to sort posts by relevant, latest, or top.
Crafting Software Architecture artefacts: Transformer Chronicles
Cover image for Crafting Software Architecture artefacts: Transformer Chronicles

Crafting Software Architecture artefacts: Transformer Chronicles

7
Comments 1
4 min read
Simplify Your Documentation Workflow with MkDocs: A Markdown-based Alternative to Sphinx
Cover image for Simplify Your Documentation Workflow with MkDocs: A Markdown-based Alternative to Sphinx

Simplify Your Documentation Workflow with MkDocs: A Markdown-based Alternative to Sphinx

13
Comments
2 min read
How to define Objects with type definitions in JSDoc comments

How to define Objects with type definitions in JSDoc comments

15
Comments
2 min read
Why AvioBook switched from Swagger UI to Bump.sh for all of their APIs
Cover image for Why AvioBook switched from Swagger UI to Bump.sh for all of their APIs

Why AvioBook switched from Swagger UI to Bump.sh for all of their APIs

Comments
4 min read
Converting Jupyter Notebooks to Markdown Made Easy with nbconvert
Cover image for Converting Jupyter Notebooks to Markdown Made Easy with nbconvert

Converting Jupyter Notebooks to Markdown Made Easy with nbconvert

17
Comments 1
3 min read
ChatGPT Unplugged: Empowering Developer for documentation
Cover image for ChatGPT Unplugged: Empowering Developer for documentation

ChatGPT Unplugged: Empowering Developer for documentation

5
Comments
6 min read
Async API documentation 101

Async API documentation 101

1
Comments
1 min read
Deployment Notes: How we document changes to production
Cover image for Deployment Notes: How we document changes to production

Deployment Notes: How we document changes to production

Comments
5 min read
Documentação Viva: Uma Nova Abordagem para Documentação de Software

Documentação Viva: Uma Nova Abordagem para Documentação de Software

4
Comments
6 min read
O Método de Documentação C4Model e sua aplicação com PUML

O Método de Documentação C4Model e sua aplicação com PUML

6
Comments
3 min read
Add comments to your Docusaurus website in 5 minutes
Cover image for Add comments to your Docusaurus website in 5 minutes

Add comments to your Docusaurus website in 5 minutes

10
Comments 15
3 min read
Effortlessly Create Documentation and Guides with Tango: The Ultimate Time-Saving Tool - It's Free
Cover image for Effortlessly Create Documentation and Guides with Tango: The Ultimate Time-Saving Tool - It's Free

Effortlessly Create Documentation and Guides with Tango: The Ultimate Time-Saving Tool - It's Free

5
Comments
4 min read
Librarian 4: a static site generator inspired by Hugo, influenced by DEV, built in PHP
Cover image for Librarian 4: a static site generator inspired by Hugo, influenced by DEV, built in PHP

Librarian 4: a static site generator inspired by Hugo, influenced by DEV, built in PHP

22
Comments
3 min read
Constructing a Personalized ChatGPT Assistant: Optimize Your Documentation with SEO Techniques
Cover image for Constructing a Personalized ChatGPT Assistant: Optimize Your Documentation with SEO Techniques

Constructing a Personalized ChatGPT Assistant: Optimize Your Documentation with SEO Techniques

Comments
6 min read
Moving Config Docs From YAML to Markdown
Cover image for Moving Config Docs From YAML to Markdown

Moving Config Docs From YAML to Markdown

8
Comments
2 min read
Getting Started with Glasp on Chrome - A Comprehensive Guide
Cover image for Getting Started with Glasp on Chrome - A Comprehensive Guide

Getting Started with Glasp on Chrome - A Comprehensive Guide

6
Comments 1
13 min read
Writing Effective User Guides for Your Software Products
Cover image for Writing Effective User Guides for Your Software Products

Writing Effective User Guides for Your Software Products

2
Comments
2 min read
Automatically Document Your Database in Markdown

Automatically Document Your Database in Markdown

30
Comments
2 min read
#DEVDiscuss: Documentation Workflows
Cover image for #DEVDiscuss: Documentation Workflows

#DEVDiscuss: Documentation Workflows

17
Comments 16
1 min read
JUnit 5: link tests with task tracker issues

JUnit 5: link tests with task tracker issues

12
Comments 3
8 min read
Using Sandpack for React Libraries Documentation
Cover image for Using Sandpack for React Libraries Documentation

Using Sandpack for React Libraries Documentation

12
Comments
5 min read
Building Better Docs - Automating Jekyll Builds and Link Checking for PRs

Building Better Docs - Automating Jekyll Builds and Link Checking for PRs

Comments
4 min read
Document or Die: The Importance of Writing Things Down in Tech

Document or Die: The Importance of Writing Things Down in Tech

64
Comments 18
4 min read
Illustrating git Branching with Markdown and Mermaid.js
Cover image for Illustrating git Branching with Markdown and Mermaid.js

Illustrating git Branching with Markdown and Mermaid.js

4
Comments
4 min read
From Data Collection to Model Deployment: Key Deliverables in a Machine Learning Project
Cover image for From Data Collection to Model Deployment: Key Deliverables in a Machine Learning Project

From Data Collection to Model Deployment: Key Deliverables in a Machine Learning Project

4
Comments
2 min read
loading...