fusionauth-site VS devdocs

Have tried to use this a few times but it's a big lift. Like adding unit tests to an existing application, it's a good idea to start small. And vale doesn't make this super easy (at least I couldn't figure out an easy way to do this). If I could wave my wand, I'd want a way to:

* apply vale to just the doc I was working on

* have a minimal set of rules

* add to them over time

At $curjob, we have a detailed public list of rules of doc ( https://github.com/FusionAuth/fusionauth-site/blob/master/Do... ) and as our team expands, I'd love to have them be applied rigorously. vale seems like a good fit, but there's an activation energy that I haven't been able to get over yet.

I am not aware of any other cli tools similar to this, though, so totally admire the team behind it.

Thanks for the comments! Will try to address them in the near future, tracking here: https://github.com/FusionAuth/fusionauth-site/issues/2170

I actually have much more experience with plantuml (we actually have a plugin which generates diagrams for our jekyll/asciidoc docs site: https://github.com/FusionAuth/fusionauth-site/blob/master/si... ), but I have recently started using mermaid for a project and like it so far.

I had a colleague (thanks Sanjay!) make a similar tool at a hackfest (you can see the source code here: https://github.com/FusionAuth/fusionauth-site/blob/master/sr... ).

I've modified it a bit to take a URL, but haven't yet set it up to read a config file to make a large number of screenshots easy to do.

We do outline certain fields or other areas in the doc to highlight a point. That's caused some hesitation on my part. However, it looks like I could use imagemagick to automatically put a red box or similar on an image (with a `-draw` command).

We have a ton of screenshots (600+) throughout our doco, and a way to initialize our product to a known state, so the pieces are all there.

One of these days it'll be worthwhile to do this.

> I've started to preface all python searches with 'site:python.org'

You might find DevDocs to be useful: https://devdocs.io/

DevDocs - Aggregates documentation from various sources into a single, easy-to-navigate interface, covering frontend and backend technologies. DevDocs

DevDocs, an offline API documentation browser, supports multilingual, offering developers a quick and efficient way to access tech docs. From front-end to back-end and mobile development, it integrates official documentation, providing a sleek, user-friendly interface.

Environmental lighting conditions rule the day! I have astigmatism and I prefer bright backgrounds; #000 text on #fff backgrounds works great for me, but that's because I work in a room lit by a 250W 30,000 lumen corn-cob LED bulb[0] that makes my small office as bright on the inside as the shaded ground from a tree on an overcast day (which is quite bright compared to usual indoor lighting). In a room that bright, high contrast text works great and is highly readable, with "dark mode" often looking washed out and muddy. Even small reductions in contrast (such as what https://devdocs.io does with text of #333 in light mode) can make me notice and wish for greater contrast.

[0] - https://www.benkuhn.net/lux/

Here's how to add a new scraper: https://github.com/freeCodeCamp/devdocs/blob/main/.github/CO...

Or open an issue and wait for somebody else to implement the scraper.

Imagine a single, intuitive platform where you can access comprehensive documentation for a vast array of programming languages, frameworks, libraries, and tools. That's the magic of DevDocs. This exceptional resource eliminates the frustration of juggling multiple tabs and websites in your quest for information. DevDocs brings everything together into one easy-to-use interface.

Mosh for a stable connection, Offline documentation such as msdn, wikipedia (via kiwi etc), zeal for local access to https://devdocs.io/; Self host tabby for ai autocompletion. For many shell programs check what mulinux was using back then, and what are the modern replacements such as elinks instead of links. Mutt for mail, for irc doesn't matter much, use a desktop one but setup a bouncher on a vps, I used to have one on a raspberry pi 1, you can use rss reader for reddit (not sure if still works) and blogs

1.DEVDOCS.IO: -- DevDocs.IO