4 ms·
I would absolutely kill for them to open source their documentation system.
by overflowy 2mo ago
I would absolutely kill for them to open source their documentation system.
- bcantrill 2mo agoAre you referring to our RFD system?[0][1] Because if so, good news![2] [0] https://rfd.shared.oxide.computer/rfd/0001 https://rfd.shared.oxide.computer/rfd/0001 [1] https://oxide-and-friends.transistor.fm/episodes/rfds-the-backbone-of-oxide https://oxide-and-friends.transistor.fm/episodes/rfds-the-ba... [2] https://github.com/oxidecomputer/rfd-site https://github.com/oxidecomputer/rfd-site
- overflowy 2mo agoOMG, you just made my day!
- mixmastamyk 2mo agoWhy would a “doc system” use React?
- dcre 2mo agoBecause it’s a web site.
- pjmlp 2mo agoBecause HTML/CSS apparently isn't enough for documentation. /s
- steveklabnik 2mo agoReact is one way of generating HTML.
- mwcampbell 2mo agoA heavy way that, as typically used, goes against the grain of the web, particularly for document-centric sites. For example, on the Oxide RFD site, the RFD links don't do a real browser page load, but use JavaScript to fetch the new content and update the page in-place. This breaks the experience of screen-reader users unless the site or framework does some kind of workaround (which, somewhat to my surprise, the Oxide RFD site doesn't do), and even then, it doesn't match the experience of doing a real transition between pages with a screen reader. For something like the Oxide RFD site, I'd be much more inclined to use something like Astro or Marko, with minimal client-side JavaScript and no SPA-style navigation.
- steveklabnik 2mo agoI would also be surprised that the RFD site breaks screen readers, generally they're pretty good about that. And yeah, you also can use react with no client side JS as well.
- fragmede 2mo agoWhy shouldn't a doc system use React? One word answers consisting of the word bloat are not going to be accepted, please use your words and be specific. The router sucks, the language is ass, give details!