Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Totally OT: apologies but gen220 you don't have contact info in your profile.

You mentioned in an old thread a few months back about using pandoc for versioned documentation in your organisation. I'm looking at doing that now -- converting to markdown, putting files in git. What we really want to do is allow users to comment their copies and the comments be kept across versions. I wondered if you had ideas on that. Currently we use PDF but Acrobat pins comments to page numbers and so they can be completely in the wrong place of pages are removed. We're using manuals that are 1000+ pages.



Heyo! Happy to spitball this with you.

(Un-)fortunately, we started in a place where we already had plaintext-ish documentation (we never started with PDFs), so we were converting text to PDFs, not the other way around.

People edit the files in markdown and "publish" them in pdfs.

Generally, we do comments in a combination of google docs views of the PDFs (not-preferred, because they die with the document version) and our code review system (preferred, because they live forever, but unfortunately exclusive to engineers).

I actually don't know to what extent pandoc supports the conversion of existing PDFs with comments to markdown, but that sounds like a really hard problem!

The way I'd move from your situation to mine, is to say "no more comments in pdfs", convert the manuals to plaintext at once, make a comment-less PR of the plaintext manual to the repo, and then hack the comments in as comments on the PR, in a way that depends on your code revision tool.

This might be very hard depending on your CR tool. Let me know if you have any more specific questions, though, I'm happy to help.

I'll also add contact info to my profile. :)


That's brill. I'll ponder some more and maybe try and get in touch ... thanks.




Consider applying for YC's Fall 2026 batch! Applications are open till July 27.

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: