search

Technical-writing-mentorship-program / Technicalwritingcourse

This repo contains resources to help you kick start your technical writing career.
https://technicalwritingmp.com/
MIT License
79 stars 37 forks source link

New article - Docs-as-code in action: Building and documenting a Python library. #209

Open Omotunde2005 opened 1 month ago

Omotunde2005 commented 1 month ago

Article title: Docs-as-code in action: Building and documenting a Python library.

Category: Technical Documentation.

Overview

This article is a comprehensive guide on how to build a python library and publish a documentation for it. The Objective of the article is to show readers the importance of docs-as-code, and how to implement it in a documentation workflow.

By showing how to build a documentation for a Python library, and maintain both code and documentation versions synchronously, readers can understand the practical implementation of docs-as-code in their workflow.

The article uses Mintlify to build and host the documentation.

Outline

The article has been completed but not published anywhere. It can be found here.

wise4rmgod commented 1 month ago

Hello Omotunde, I will review it and get back to you. Thanks for writing this peice

Omotunde2005 commented 1 month ago

Okay, thank you sir.

Omotunde2005 commented 1 month ago

Hello @wise4rmgod .

I've corrected the highlighted errors. The article has also been split into two as suggested. Below are the links to the articles:

How to build and publish a Python library

Documenting a Python library