Hacker News with Generative AI: Documentation

GitSummarize – Generate living documentation from any GitHub repo (gitsummarize.com)
Turn any GitHub repository into a comprehensive AI-powered documentation hub.
Software, GitHub, AI, Documentation, Open Source
5 points by hsiYwko 10 hours ago | 0 comments
Show HN: Generate docs from your public repos (docs.dev)
Software Development, Documentation, Open Source, Tools
27 points by linktothenew 9 days ago | 11 comments
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?
Open Source, Documentation, Software Development, Community
13 points by reporangers 11 days ago | 8 comments
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).
Python, API, Documentation, Frameworks, Open Source
153 points by mr_Fatalyst 12 days ago | 77 comments
Decoded: GNU Coreutils (2019) (maizure.org)
This is a long-term project to decode all of the GNU coreutils in version 8.3.
Open Source, Documentation
6 points by pcfwik 13 days ago | 0 comments
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.
AI, Documentation, Legacy Code, Code Generation, Tools
8 points by Jonverrier 14 days ago | 2 comments
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, ROCm, Documentation, Software, Cloud Computing
5 points by rbanffy 15 days ago | 0 comments
The Document Culture of Amazon (2021) (justingarrison.com)
In my time at Amazon, I’ve observed the way we use documents is incredibly unique.
Amazon, Company Culture, Work Culture, Documentation
23 points by Tomte 15 days ago | 15 comments
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.
Technical Writing, Documentation, Education, Software Development
212 points by Tomte 18 days ago | 75 comments
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.
Software, Documentation, Programming
28 points by eigenvalue 20 days ago | 7 comments
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, Programming, Documentation
155 points by danso 29 days ago | 55 comments
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.
Software Development, Documentation, Writing
73 points by taubek 30 days ago | 73 comments
We Designed TigerBeetle's Docs from Scratch (tigerbeetle.com)
We recently rebuilt TigerBeetle’s docs site from scratch.
Software, Documentation, Development
15 points by todsacerdoti 35 days ago | 0 comments
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, Security, Programming, Documentation, XSS
43 points by campuscodi 39 days ago | 11 comments
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.
Software, Artificial Intelligence, Startups, Documentation, Customer Experience
107 points by prithvi2206 44 days ago | 61 comments
Show HN: Generate instant docs, tutorials and code reviews for any GitHub repo (entelligence.ai)
GitHub, Code Review, Documentation, Software Development, AI
14 points by aiswaryasbuilds 48 days ago | 11 comments
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.
Code Generation, Open Source, AI Tools, Documentation
281 points by tesserato 48 days ago | 164 comments
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.
GitHub, Microsoft, Documentation
4 points by myroon5 55 days ago | 2 comments
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.
Markdown, Documentation, AsciiDoc, Open Source, Tools
101 points by pointnova 56 days ago | 63 comments
O3-mini System Card [pdf] (openai.com)
Hardware, OpenAI, Documentation
56 points by synthwave 62 days ago | 24 comments
FFmpeg by Example (ffmpegbyexample.com)
FFmpeg By Example is a documentation website to showcase all the unique and different ways to use FFmpeg.
FFmpeg, Documentation, Video Editing, Multimedia, Software
920 points by piyushsthr 79 days ago | 246 comments
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.
Nvidia GPUs, Documentation, Glossary, Computer Hardware
230 points by birdculture 81 days ago | 70 comments
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.
Programming Languages, Documentation, Crystal Language
12 points by benatkin 82 days ago | 3 comments
DoxyPress – Modern Doxygen (copperspice.com)
What is DoxyPress What is CopperSpice
Software, Documentation, Development Tools
33 points by jcbhmr 83 days ago | 11 comments
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.
Software Development, Documentation, Testing
4 points by onel 84 days ago | 5 comments
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.
Technical Writing, Documentation, Software Development, Frameworks
96 points by remoquete 84 days ago | 10 comments
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.
Open Source, Developer Tools, Documentation, Software Development
4 points by emschwartz 84 days ago | 0 comments
Fast WYSIWYG tool for building and self-hosting professional documentation sites (tiledocs.com)
Create professional documentation websites with our no-code online editor
Documentation, Web Development, No-Code, Tools, Self-Hosting
4 points by aksuta_ipse 96 days ago | 0 comments
Why your team needs a Technical Writer to manage your documentation (momorell.com)
Technical Writing, Documentation, Software Development, Teams
9 points by mooreds 96 days ago | 1 comments
Microsoft rejects documentation PR because AI chatbots can't display tables (github.com/MicrosoftDocs)
Microsoft, AI, Documentation, Chatbots, Tables
108 points by panic 107 days ago | 30 comments