Hacker News with Generative AI: Documentation

Better Than Man Pages? These Tools Help You Understand Linux Commands (itsfoss.com)
Reading the classic man pages could be intimidating and confusing. These tools simplify getting help on command syntaxes in Linux.
Linux, Command Line, Documentation, Tools
7 points by PaulKeeble 32 days ago | 0 comments
Ask HN: Can you give tips on writing a README for project? (ycombinator.com)
I'm currently finishing up the initial version of my experimental embeddable library designed for creating web applications without a build step.
Open Source, Software Development, Programming, GitHub, Documentation
6 points by vseplet 34 days ago | 7 comments
Introduction to MCP Security (unisys.com)
Unisys Corporation has established this website for the purpose of providing users with convenient access to non-confidential documentation ("information") pertaining to Unisys products and services.
Security, Unisys, Documentation
19 points by rbanffy 41 days ago | 2 comments
A Rust Documentation Ecosystem Review (harudagondi.space)
I’ve been thinking about documentation lately.
Rust, Programming Languages, Documentation, Software Development
94 points by hyperbrainer 47 days ago | 14 comments
Docs like code in basic terms (deborahwrites.com)
Most guides to docs like code, even the ones for non-devs, assume you have some developer knowledge: maybe you're already using version control, or you've encountered build pipelines before, or you're working alongside developers.
Technical Writing, Documentation, Software Development
66 points by DeborahWrites 53 days ago | 60 comments
Can you remove ads from the documentation? (github.com/dotnet)
Can you remove ads from the documentation? #45996
Software, Documentation, Open Source
25 points by sensanaty 55 days ago | 10 comments
Ask HN: AI tools to help you learn faster (GitHub, books, PDFs) (ycombinator.com)
It feels the way to learn in the age of AI should be totally different. Eg I came across https://github.com/AsyncFuncAI/deepwiki-open and it's amazing at helping you quickly understand a repo. What other tools like this exist for github repos / books / PDFs / whitepapers / etc?
AI, Learning, Tools, Programming, Documentation
15 points by ilmoi 56 days ago | 5 comments
A simple Common Lisp web app (scotto.me)
One of the drawbacks of dealing with Common Lisp is the lack of documentation available. Too often, I find published libraries without an explanation of how to use them or only partially documented, and I need to dig into the source code to understand how they work or if that method is present or not.
Common Lisp, Web Development, Programming, Documentation
63 points by silcoon 58 days ago | 21 comments
Atuin Desktop: Runbooks That Run (atuin.sh)
Atuin Desktop looks like a doc, but runs like your terminal. Script blocks, embedded terminals, database clients and prometheus charts - all in one place.
DevOps, Automation, Software, Documentation
572 points by freetonik 66 days ago | 150 comments
Coreboot: Mainboard-Specific Documentation (coreboot.org)
This section contains documentation about coreboot on specific mainboards.
Coreboot, Hardware, Documentation
3 points by 1vuio0pswjnm7 72 days ago | 0 comments
Acorn's File Format Documented (shapeof.com)
With the release of Acorn 8 last December, I published "ACTN002 Acorn's Native File Format" as part of the documentation updates, which is exactly what it sounds like.
File Formats, Documentation, Software, New Releases
5 points by zdw 77 days ago | 0 comments
We Designed TigerBeetle's Docs from Scratch (tigerbeetle.com)
We recently rebuilt TigerBeetle’s docs site from scratch.
Software, Documentation, Design
72 points by mooreds 81 days ago | 38 comments
Ask HN: As an eng leader, how useful is AI-generated internal documentation? (ycombinator.com)
Engineering Leadership, Artificial Intelligence, Documentation, Software Development
6 points by hsiYwko 83 days ago | 5 comments
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
6 points by hsiYwko 86 days ago | 0 comments
Show HN: Provide LLMs markdown documentation of libraries and frameworks (github.com/CartographAI)
Documentation, Libraries, Frameworks, Open Source
6 points by vivekkalyan 86 days ago | 0 comments
Show HN: Generate docs from your public repos (docs.dev)
Software Development, Documentation, Open Source, Tools
27 points by linktothenew 94 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 96 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 97 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 98 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 100 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 100 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 100 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 103 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 105 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 114 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 115 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 120 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 125 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 129 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 133 days ago | 11 comments