Published On: February 2nd, 2023Categories: AI News

We took the arguably unusual choice to build a desktop app for documentation. If you look around, documentation tools generally fall in 2 categories: open source CLI tools, and cloud-based WYSIWYG editors. In this post we’ll talk about the reasoning that lead us to build a desktop app instead, and how it actually works.



What is it for?

Our desktop app allows users to preview what their documentation will look like once published. It also catches errors such as broken links or syntactical problems.

Users can open our app next to their editor of choice, edit their Markdown documents, and the app will refresh on every save to reflect the latest version.

an animation of the Doctave app updating the content shown when an edit is made in a text editor

When an error is detected, the user is immediately notified, and clicking on the link in the error takes you to the page with the issue.

a cropped screenshot of the desktop app showing an error notifying the user about a broken link

While my opinion is obviously biased, this fast feedback loop is amazing to work in. It takes the app milliseconds to do a complete re-render of the project, so you’re…

Source link

We took the arguably unusual choice to build a desktop app for documentation. If you look around, documentation tools generally fall in 2 categories: open source CLI tools, and cloud-based WYSIWYG editors. In this post we’ll talk about the reasoning that lead us to build a desktop app instead, and how it actually works.



What is it for?

Our desktop app allows users to preview what their documentation will look like once published. It also catches errors such as broken links or syntactical problems.

Users can open our app next to their editor of choice, edit their Markdown documents, and the app will refresh on every save to reflect the latest version.

an animation of the Doctave app updating the content shown when an edit is made in a text editor

When an error is detected, the user is immediately notified, and clicking on the link in the error takes you to the page with the issue.

a cropped screenshot of the desktop app showing an error notifying the user about a broken link

While my opinion is obviously biased, this fast feedback loop is amazing to work in. It takes the app milliseconds to do a complete re-render of the project, so you’re…

, Why we built a Rust-powered desktop app for previewing documentation , Nik Begley , 2023-02-02 14:25:36 , DEV Community 👩‍💻👨‍💻 , , https://res.cloudinary.com/practicaldev/image/fetch/s–wHHqQcA_–/c_imagga_scale,f_auto,fl_progressive,h_500,q_auto,w_1000/https://dev-to-uploads.s3.amazonaws.com/uploads/articles/oldd816xyzd1u8up3xku.png , [rule_{ruleNumber}] , [rule_{ruleNumber}_plain] , , , https://dev.to/doctave/why-we-built-a-rust-powered-desktop-app-for-previewing-documentation-29nd , https://dev.to/doctave/why-we-built-a-rust-powered-desktop-app-for-previewing-documentation-29nd , dev.to , https%3A%2F%2Fdev.to%2Fdoctave%2Fwhy-we-built-a-rust-powered-desktop-app-for-previewing-documentation-29nd , rust,writing,javascript,webdev , Prompt, #built #Rustpowered #desktop #app #previewing #documentation

Leave A Comment