Include #258 (comment)

Also document the fifo based previewer.

Still WIP.

Moved major parts of the Wiki to https://arijitbasu.in/xplr/en/.

Still a lot to do.

Hello👋! I'd like to work on this. Can you give me directives on how to do that?

Hey @tobihans thanks for your interest in this project. Pls let me know which OS do you use and give me some time to write the instructions for you.

Okay, I have a 64bits machine powered by Manjaro Linux.

Okay, I have a 64bits machine powered by Manjaro Linux.

Same as me :) I'm on Manjaro + KDE + KWin

Instructions

So, first, I'd read some existing docs to get a feel of how the docs are structured. Then go inside the docs directory, run mdbook serve --open and search for TODO.

➜  src git:(main) grep TODO *
filtering.md:TODO: document each
general-config.md:TODO: Continue documentation.
layouts.md:TODO: document each constraint.
message.md:[TODO][66]
sorting.md:TODO: document each
SUMMARY.md:- [TODO][21]
todo.md:TODO

(Ignore the SUMMARY.md & TODO.md files)

Then visit src/init.lua to find the configuration options that are not covered in the docs. I was documenting from top to bottom, before giving up and sticking TODOs.

So, for each field in the config file, we need to write the heading, describe briefly what it does, and describe the type.

To know the type of each field, refer to the crate documentation.

If it gets too difficult to document the type of a field, just link to the crate doc and move on to the next field. We can always revisit it to find fields linking to the Rust doc and convert them to Lua.

NOTE: If you see a Rust type Option<String>, in Lua it'd be nullable string.

Okay, I understand. Thanks!

Top-level config has been fully documented in #357, thanks to @tobihans.

Still some TODOs left. We should be able to close it soon.

Hey, yes there is some remaining work. I was busy due to school, I'll try my best to finish it ASAP.

@tobihans no worries, study & personal time comes first. I posted the update primarily to remind myself so that I don't get anxious when I revisit old issues.

Okay, I understand, thanks.

Just a suggestion, the "how do I use this" documentation is kind of lacking. You're documenting how to configure it and all the Lua internals... when coming to this as an existing user of ranger no stranger to text based file managers or vim style modal tools... I couldn't work out how to get it to do basic stuff like select a bunch of files then "copy and paste"/move them to another directory. So far the only basic operation I was able to intuitively master was multiple selection and then deletion. The help is... not great... since it just says I should be able to just use "m" once I'm in the action mode but that doesn't seem to work, so off I go to look for documentation to make sure I'm using it correctly, and ... I've got nothing. No "how to use" documentation for basic operations at all.

Hey, @techdragon thanks for the valuable feedback. However, I think the basic "how do I use this" guides would be more effective in video format instead of text, since it's a lot of content and writing/reading would be very time-consuming.

But, since it's a relatively new project, so far we got only one video introducing xplr which does cover copying and moving files (should we link it in the docs too?), and I hope there will be more videos soon.

(my voice and accent is horrible, so I can't really make great videos explaining stuff)