Nostr Web Client

So this opinion probably comes from the fact that I've never written extensive documentation before. But if you take the time to write a lot of documentation for an application and spend the time to set up a complex website for it.......would it be that much extra effort to distill it into a much less pain in the ass PDF for people?

I'm trying to read the docs for a new web hosting app I'm using, but the doc website is set up so poorly that's it a pain in the ass to read through. But they obviously put a lot of effort into it. 🤦‍♂️

Reply to this note

Please Login to reply.

Discussion

₿itcoin 1y ago

Plain text is handy.

₿itcoin 1y ago

because you can easily search trough it. A search bar is the most important. Not on the server, but just local. In the browser or text editor.

This would be my top documentation experience:

I have a problem, I visit documentation site, I see everything in plain text and thus I can search in an instant trough all text to find what I need. I might even easily copy all text at once, paste it into vim or another text editor, and use advanced search. I could even use `git grep "search string"` if the documentation is a github repo.

𝟭𝗨𝗣 1y ago

it's probably deliberate which is extra shameful

cloud fodder 1y ago

I recently discovered a nice plugin for vscode that exports markdown as PDF. I love it. (Because I'm usually writing with markdown and most docs in coding/blogging world are markdown)

frphank 1y ago

How about clickable links?

I recommend the markdown plugin for Chrome/Firefox where you just browse the markdown rendered to HTML on the fly.

cloud fodder 1y ago

PDFs have clickable links I think 🤔

frphank 1y ago

And if the link target is another markdown in a set of markdowns? It generates a set of PDFs? I like browser extension. Markdowns are more like HTML web pages, PDF is structurally different.