Ask HN: Best open source project that has terrible documentation?
(ycombinator.com)
I am building some code documentation tools and want to contribute to the open source community - what open source documentation gives you a headache?
I am building some code documentation tools and want to contribute to the open source community - what open source documentation gives you a headache?
Show HN: FastOpenAPI – automated docs for many Python frameworks
(github.com/mr-fatalyst)
FastOpenAPI is a library for generating and integrating OpenAPI schemas using Pydantic v2 and various frameworks (Falcon, Flask, Sanic, Starlette, Tornado).
FastOpenAPI is a library for generating and integrating OpenAPI schemas using Pydantic v2 and various frameworks (Falcon, Flask, Sanic, Starlette, Tornado).
Decoded: GNU Coreutils (2019)
(maizure.org)
This is a long-term project to decode all of the GNU coreutils in version 8.3.
This is a long-term project to decode all of the GNU coreutils in version 8.3.
Show HN: AI-Powered Documentation Generator for Legacy Codebases
(github.com/jonverrier)
McpDoc is a Model Context Protocol (MCP) server implementation designed to generate documentation for existing systems. It provides a set of MCP prompts and tools for generating code summaries and C4 architecture diagrams using Mermaid.js.
McpDoc is a Model Context Protocol (MCP) server implementation designed to generate documentation for existing systems. It provides a set of MCP prompts and tools for generating code summaries and C4 architecture diagrams using Mermaid.js.
Beyond the ROCm Software, AMD Has Been Making Great Strides in Documentation
(phoronix.com)
AMD recently allowed me some time with their AMD Accelerator Cloud (AAC) leveraging multiple Instinct MI300X accelerators. During this brief opportunity to try out their latest software advancements with the Instinct MI300X and the ROCm compute stack, one of the most striking takeaways was their documentation improvements compared to previous forays into ROCm+Instinct compute. In addition, AMD is now offering more robust container options for easier Instinct compute deployments with more software options available and being more regularly updated.
AMD recently allowed me some time with their AMD Accelerator Cloud (AAC) leveraging multiple Instinct MI300X accelerators. During this brief opportunity to try out their latest software advancements with the Instinct MI300X and the ROCm compute stack, one of the most striking takeaways was their documentation improvements compared to previous forays into ROCm+Instinct compute. In addition, AMD is now offering more robust container options for easier Instinct compute deployments with more software options available and being more regularly updated.
The Document Culture of Amazon (2021)
(justingarrison.com)
In my time at Amazon, I’ve observed the way we use documents is incredibly unique.
In my time at Amazon, I’ve observed the way we use documents is incredibly unique.
Teach, Don't Tell (2013)
(stevelosh.com)
The purpose of technical documentation is to take someone who has never seen your project, teach them to be an expert user of it, and support them once they become an expert.
The purpose of technical documentation is to take someone who has never seen your project, teach them to be an expert user of it, and support them once they become an expert.
Show HN: LLM-docs, software documentation intended for consumption by LLMs
(github.com/Dicklesworthstone)
LLM-Docs provides condensed, optimized documentation specifically tailored for efficient consumption by Large Language Models (LLMs). Traditional documentation, primarily designed for humans, often includes redundant content, extraneous formatting, and promotional material that unnecessarily occupies valuable context window space in LLMs. This project aims to create streamlined documentation, maximizing the efficiency and effectiveness of LLM-assisted programming tasks.
LLM-Docs provides condensed, optimized documentation specifically tailored for efficient consumption by Large Language Models (LLMs). Traditional documentation, primarily designed for humans, often includes redundant content, extraneous formatting, and promotional material that unnecessarily occupies valuable context window space in LLMs. This project aims to create streamlined documentation, maximizing the efficiency and effectiveness of LLM-assisted programming tasks.
The features of Python's help() function
(pythonmorsels.com)
Python has a built-in help function for getting help... but what can do with help?
Python has a built-in help function for getting help... but what can do with help?
Writing small docs is a game changer
(bufferbuffer.com)
In software development, there has been multiple instances of people advocating or discussing opting for small commits. This makes sense for a number of reasons, but there are also writers in my company advocating for small docs. And it makes sense.
In software development, there has been multiple instances of people advocating or discussing opting for small commits. This makes sense for a number of reasons, but there are also writers in my company advocating for small docs. And it makes sense.
We Designed TigerBeetle's Docs from Scratch
(tigerbeetle.com)
We recently rebuilt TigerBeetle’s docs site from scratch.
We recently rebuilt TigerBeetle’s docs site from scratch.
Python's official documentation contains textbook example of insecure code (XSS)
(seclists.org)
Python's official documentation contains textbook example of insecure code (XSS)
Python's official documentation contains textbook example of insecure code (XSS)
Launch HN: Promptless (YC W25) – Automatic updates for customer-facing docs
(ycombinator.com)
Hi HN! I’m Prithvi, and my co-founder Frances and I built Promptless (https://gopromptless.ai), an AI teammate that proactively updates docs while you ship software.
Hi HN! I’m Prithvi, and my co-founder Frances and I built Promptless (https://gopromptless.ai), an AI teammate that proactively updates docs while you ship software.
Show HN: Transform your codebase into a single Markdown doc for feeding into AI
(tesserato.web.app)
Continuing to open-source internal tools, I'm releasing CodeWeaver, a CLI to generate a single markdown file from a directory of source files. The idea is to facilitate sharing and feeding the codebase information to AI tools.
Continuing to open-source internal tools, I'm releasing CodeWeaver, a CLI to generate a single markdown file from a directory of source files. The idea is to facilitate sharing and feeding the codebase information to AI tools.
MicrosoftDocs GitHub Issues Hidden
(microsoft.com)
At Microsoft Learn, we are committed to empowering you with the tools and resources you need to build technical skills and achieve your goals.
At Microsoft Learn, we are committed to empowering you with the tools and resources you need to build technical skills and achieve your goals.
Markdown's Big Brother: Say Hello to AsciiDoc
(git-tower.com)
We’ve all been there: a single README.md file was enough in the early days of your project. But as new features and contributors rolled in, maintaining that lightweight Markdown file started feeling like juggling knives.
We’ve all been there: a single README.md file was enough in the early days of your project. But as new features and contributors rolled in, maintaining that lightweight Markdown file started feeling like juggling knives.
FFmpeg by Example
(ffmpegbyexample.com)
FFmpeg By Example is a documentation website to showcase all the unique and different ways to use FFmpeg.
FFmpeg By Example is a documentation website to showcase all the unique and different ways to use FFmpeg.
The Missing Nvidia GPU Glossary
(modal.com)
We wrote this glossary to solve a problem we ran into working with GPUs here at Modal: the documentation is fragmented, making it difficult to connect concepts at different levels of the stack, like Streaming Multiprocessor Architecture, Compute Capability, and nvcc compiler flags.
We wrote this glossary to solve a problem we ran into working with GPUs here at Modal: the documentation is fragmented, making it difficult to connect concepts at different levels of the stack, like Streaming Multiprocessor Architecture, Compute Capability, and nvcc compiler flags.
The Macros module is a fictitious module used to document macros
(crystal-lang.org)
The Macros module is a fictitious module used to document macros and macro methods.
The Macros module is a fictitious module used to document macros and macro methods.
Documentation is more important than tests
(anonel.substack.com)
Without the intention of making a click-bait-y title, I really think docs and tests are almost equal in importance, but if a company would only have resources to do one, they should choose documentation.
Without the intention of making a click-bait-y title, I really think docs and tests are almost equal in importance, but if a company would only have resources to do one, they should choose documentation.
The Seven-Action Documentation Model
(passo.uno)
I think all technical writers, at some point or another, feel the urge to base their work on something more systematic than “it’s just the way folks documented stuff since forever”. Toolkits and frameworks provide content types, which is immensely valuable when you know what you want to write, but starting from there is like buying a hammer without knowing that half of the work you’ll do is turning screws.
I think all technical writers, at some point or another, feel the urge to base their work on something more systematic than “it’s just the way folks documented stuff since forever”. Toolkits and frameworks provide content types, which is immensely valuable when you know what you want to write, but starting from there is like buying a hammer without knowing that half of the work you’ll do is turning screws.
Open source all the way down: Upgrading our developer documentation
(cloudflare.com)
At Cloudflare, we treat developer content like a product, where we take the user and their feedback into consideration. We are constantly iterating, testing, analyzing, and refining content. Inspired by agile practices, treating developer content like an open source product means we approach our documentation the same way an open source software project is created and maintained.
At Cloudflare, we treat developer content like a product, where we take the user and their feedback into consideration. We are constantly iterating, testing, analyzing, and refining content. Inspired by agile practices, treating developer content like an open source product means we approach our documentation the same way an open source software project is created and maintained.
Fast WYSIWYG tool for building and self-hosting professional documentation sites
(tiledocs.com)
Create professional documentation websites with our no-code online editor
Create professional documentation websites with our no-code online editor
Documented and annotated source code for Elite on the Commodore 64
(github.com/markmoxon)
This repository contains the original source code for Elite on the Commodore 64, with every single line documented and (for the most part) explained.
This repository contains the original source code for Elite on the Commodore 64, with every single line documented and (for the most part) explained.