frontpage.
newsnewestaskshowjobs

Made with ♥ by @iamnishanth

Open Source @Github

Ask HN: How did Soham Parekh get so many jobs?

277•jshchnz•4d ago•386 comments

Ask HN: Has AWS ever surprised you with a bill?

4•noway_bro•4h ago•2 comments

Ask HN: How is the tech scene in LA?

5•asdev•4h ago•0 comments

Ask HN: How do I buy a typewriter?

5•indus•6h ago•11 comments

mTLS vs. HTTP Message Signatures: Tradeoffs in Securing HTTP Requests

2•getvictor•6h ago•2 comments

Ask HN: How to generate product docs E2E?

2•sarabande•9h ago•1 comments

Ask HN: Advice for Starting a Hacker Space?

28•pkdpic•1d ago•30 comments

ARZY-G: A token born from AI-validated usefulness (not mined, not bought)

3•arzykul•11h ago•0 comments

Ask HN: Worth leaving position over push to adopt vibe coding?

69•NotAnOtter•2d ago•86 comments

Ask HN: What Are You Working On? (June 2025)

438•david927•1w ago•1377 comments

Ask HN: Freelancer? Seeking freelancer? (July 2025)

84•whoishiring•5d ago•203 comments

CellularLab – A Modern Android iPerf3 App with TCP/UDP Testing and AI Analysis

2•abhi5h3k•15h ago•0 comments

Ask HN: Who is hiring? (July 2025)

268•whoishiring•5d ago•381 comments

Ask HN: How many communities HN it devs in C language?

7•FerkiHN•1d ago•10 comments

Proposal: GUI-first, text-based mechanical CAD inspired by software engineering

3•thinkmachyx•1d ago•4 comments

Ask HN: Who wants to be hired? (July 2025)

128•whoishiring•5d ago•364 comments

Why did not numpy copy the J rank concept?

14•jrank•1d ago•6 comments

Ask HN: What's the 2025 stack for a self-hosted photo library with local AI?

224•jamesxv7•6d ago•120 comments

Tell HN: A fake, highly obfuscated Solidity VSCode plugin found on marketplace

14•navad•1d ago•1 comments

Looking for Early Testers for a AI Assistant Inside Zotero

10•jie6•2d ago•1 comments

Go-msquic: v0.11 is out

2•noboruma•13h ago•0 comments

Ask HN: Is there a business for extracting US tech talent?

27•Arubis•3d ago•37 comments

Super Simple "Hallucination Traps" to detect interview cheaters

29•EliotHerbst•4d ago•37 comments

Ask HN: What clever tools/scripts do you use to manage development environments?

9•sebst•1d ago•13 comments

Ask HN: How do you sell to B2B in current state of AI?

4•salesdo•1d ago•6 comments

1KB JavaScript Demoscene Challenge Just Launched

115•babakode•5d ago•31 comments

If Emacs is not a text editor, then what is it really?

4•hushangazar•2d ago•2 comments

Ask HN: Are there any good WASM-based sites for learning Bash, Linux and CLI?

8•brightbeige•2d ago•2 comments

Ask HN: Requests for Software – have something you want built?

9•NewUser76312•1d ago•7 comments

Ask HN: What are the best resources to help with health insurance denials?

10•cigna•3d ago•11 comments
Open in hackernews

Ask HN: How to generate product docs E2E?

2•sarabande•9h ago
I have an existing handwritten knowledgebase with screenshots of an app, a codebase with standard CI/CD pipelines, and an API whose docs are autogenerated against an OpenAPI spec.

Is there a convenient way these days to chain software together so that product documentation, including screenshots, is completely autogenerated on new codebase commits? Anyone tried some chain of tools, including paid ones, that works successfully in the wild?

Comments

ok1984•9h ago
In my experience, If you want to auto-generate your documentation then most likely is not useful, documentation should explain concepts, domain knowledge, architectural decisions and much more that you can’t have fit as a one-to-one mapping with your code.

Also, writing documentation is athat moment that makes you think about your software from a different perspective, often times I discovered and refactored my code during the process of writing down documentation.

We use Antora and VSC to write down our documentation.