Hacker News with Generative AI: Documentation

Readme.so – Easy way to create a README (readme.so)
Our simple editor allows you to quickly add and customize all the sections you need for your project's readme

Software, Tools, Open Source, Documentation, GitHub

72 points by ahamez 5 days ago | 32 comments

C Gibberish to English (cdecl.org)

C, Programming, Tools, Documentation

66 points by warkanlock 10 days ago | 50 comments

MdBook – a command line tool to create books with Markdown (rust-lang.github.io)
mdBook is a command line tool to create books with Markdown. It is ideal for creating product or API documentation, tutorials, course materials or anything that requires a clean, easily navigable and customizable presentation.

Markdown, Documentation, Tools, Command Line

184 points by peter_d_sherman 11 days ago | 69 comments

Show HN: Java Markdown – living docs with Java code (reportmill.com)
SnapCode makes it fast and easy to start coding Java in any modern browser.

Java, Programming, Documentation, Web Development, Tools

4 points by jeffreportmill1 14 days ago | 0 comments

AMD64 Architecture Programmer's Manual Volumes 1–5 [pdf] (amd.com)

AMD64 Architecture, Programming, Hardware, Documentation

28 points by sandwichsphinx 16 days ago | 7 comments

Hurmet: A Notebook for Calculations (hurmet.org)
Create documents with working, well-documented calculations!

Mathematics, Tools, Software, Documentation

25 points by froober 21 days ago | 7 comments

Pimp My Man (kszenes.github.io)
This article follows up on my previous blog post on improving the experience of digging through the documentation of command line interface tools. In that article, I detailed my preferred method for fetching documentation using the cheat.sh website.

Documentation, Tools

15 points by d3m0t3p 24 days ago | 2 comments

Free open source documentation by GitBook that helps fund your project (gitbook.com)
At GitBook, part of our mission is to lift up and support open source projects. Not just because it’s where we started as a company. Because we believe that open source knowledge will empower the next generation of developers to build amazing products.

Open Source, Documentation, Funding, GitBook

15 points by neoziro 28 days ago | 0 comments

What docs-as-code means (passo.uno)
I’ve recently started a new job as a documentation engineer. While my work is largely the same as that of a technical writer, the sound and semantics of my new job title gave me some pause and made me think about what it really means to be doing docs-as-code. To say that it’s about writing documentation using the same tools and methods as software developers is correct, but fails to acknowledge the full consequences of the fact.

Software Development, Documentation, Technical Writing, Workflow

102 points by remoquete 32 days ago | 113 comments

Google: Search Quality Rating Guidelines [pdf] (googleusercontent.com)

Search Engines, Google, Quality, Documentation

14 points by stefankuehnel 34 days ago | 1 comments

Unit tests as documentation (thecoder.cafe)
Hello! Let’s continue our series on unit tests by discussing their relation with documentation.

Unit Testing, Documentation, Software Development

174 points by thunderbong 35 days ago | 213 comments

Ask HN: Recommendation for LLM-based "documentation interaction" (ycombinator.com)
I would like to try out fine-tuning (or whatever process is the right one) a LLM on the documentation of one of our frameworks.

Documentation, Software Development

18 points by kchnkrml 37 days ago | 6 comments

RoRvsWild Ruby Documentation Theme (rorvswild.com)
As much as we enjoy Ruby, we have long thought the Ruby documentation could use more love. We could contribute and give some.

Ruby, Programming, Documentation, Web Development

38 points by thunderbong 37 days ago | 9 comments

Show HN: Self-Hostable Algolia DocSearch Replacement (github.com/fastrepl)
🐤 Canary is modern Algolia DocSearch replacement.

Software, Search, Open Source, Documentation

111 points by yujonglee 40 days ago | 42 comments

HTML for People (htmlforpeople.com)
HTML isn’t only for people working in the tech field. It’s for anybody, the way documents are for anybody. HTML is just another type of document. A very special one—the one the web is built on.

HTML, Web Development, Learning, Documentation

10 points by todsacerdoti 42 days ago | 1 comments

Show HN: Stride – local-first Markdown-based engineering calcs and documentation (get-stride.com)
Stride is a modern technical documentation and calculation software for engineers and other calculation-driven professionals to improve calculation quality, communicate better, and decrease costs.

Software, Engineering, Documentation, Markdown

5 points by weikequ_ 42 days ago | 0 comments

An RKRM-style reference of AmigaDOS/dos.library (github.com/thorfdbg)
This project is a documentation of the AmigaDOS subsystem of AmigaOs, the dos.library, its handlers, file-systems and structures. It is available under the THOR-Software License v3.

Amiga, Operating Systems, Programming, Documentation

20 points by doener 45 days ago | 1 comments

Show HN: Open-source library documentation for LLMs (docs.codes)
Get latest context for open-source libraries to use with cursor/copilot/chatgpt.

Open Source, Documentation, Programming Tools

12 points by rohansood15 50 days ago | 0 comments

GitHub's Copilot lies about its documentation. Why would I trust it with my code (shkspr.mobi)
GitHub's Copilot lies about its own documentation. So why would I trust it with my code?

GitHub, Software, AI, Programming, Documentation

36 points by edent 50 days ago | 77 comments

Roll Up Terminals into a Knowledge Base (runme.dev)
About a decade ago, some wise guys (myself included) tried to convince you to Trust the Source, Luke and make the code your docs—just ditch documentation entirely. BDD, Terraform, GitOps, a couple of Ruby-DSLs, and years later, we found that, yes, for certain things, code is a better solution than documents: unit tests, delivery pipelines, smoke tests, IaC at scale, etc.

Software Development, Documentation, Automation, DevOps

10 points by thunderbong 56 days ago | 1 comments

The Six Types of Documentation (mastodon.social)

Documentation, Writing, Software Development, Communication

12 points by sonicrocketman 57 days ago | 0 comments

Fully documented source code for Lander on the Acorn Archimedes (bbcelite.com)
This site contains reconstructed source code for Lander, David Braben's epic game for the Acorn Archimedes, with every single line documented and (for the most part) explained.

Retro Gaming, Programming, Acorn Archimedes, Documentation, Source Code

168 points by ibobev 58 days ago | 39 comments

OpenAPI 3.1 Cheat Sheet (bump.sh)
Now that you’ve roamed through the Complete Guide, let’s make long stories short. We have listed the key elements you should always keep in mind when writing a new OpenAPI contract, or maintaining existing ones.

API, OpenAPI, Documentation

19 points by jayku 66 days ago | 3 comments

The book documenting the curl project, the curl tool, libcurl and more (github.com/curl)

Software, Programming, Open Source, Documentation, Tools

18 points by parkor 67 days ago | 2 comments

Ask HN: What's the best documentation site you've come across? (ycombinator.com)
I think back then devs seems to praise Stripe's docs site. Is it still relevant right now?

Software, Documentation, Web Development, User Experience

31 points by sawirricardo 68 days ago | 35 comments

OpenAI o1 System Card [pdf] (openai.com)

OpenAI, AI Safety, Documentation

57 points by cubefox 70 days ago | 6 comments

Show HN: Auto-document your analytics setup (npx package) (github.com/fliskdata)
Automatically document your analytics setup by analyzing tracking code and generating data schemas from tools like Segment, Amplitude, Mixpanel, and more 🚀.

Software, Analytics, Documentation, Data, Automation

17 points by sameenkarim 71 days ago | 5 comments

Documenting Dance: Keeping Score (2017) (wordpress.com)
There are many things in life that I’m not proficient at. One is learning languages. Another is dance. So, you can imagine how interesting this past week has been. (Sidenote: I’m aware it’s been well over a week. This post has been in my drafts for so long, guys, I’m sorry. Every time I thought I was ready to publish, I found out something new!)

Dance, Documentation, Personal Writing

111 points by mont_tag 75 days ago | 26 comments

Asciidoctor: A fast text processor and publishing toolchain (asciidoctor.org)
Asciidoctor is a fast, open source, Ruby-based text processor for parsing AsciiDoc® into a document model and converting it to output formats such as HTML 5, DocBook 5, manual pages, PDF, EPUB 3, and other formats.