search

oxen-io / oxen-docs-gitbook

Mirror of the Gitbook docs
9 stars 18 forks source link

Documentation confusion #1

Closed MassiveBox closed 3 years ago

MassiveBox commented 3 years ago

There are some points I find weird about the Oxen documentation, and I think might lead to confusion on the user end, so I'm listing them here in hope that the devs will consider explaining or changing some of this stuff.

  1. Session and Lokinet explaination repeated twice https://docs.oxen.io/building-with-oxen/lokinet and https://docs.oxen.io/products-built-on-oxen/lokinet https://docs.oxen.io/building-with-oxen/session and https://docs.oxen.io/products-built-on-oxen/session I don't get why these sections are split up, and have different content. For example, in the Lokinet page in the "building with oxen" folder, there are some video guides to set up SNApps but no text guides, which are in the other page, and vice versa. Maybe the devs will explain why this separation exists, but I think these four pages should be merged into two with all the information.

  2. Oxen Android Wallet Download I understand that the Android wallet is a major WIP, but I see no reason why there's only a link to the Google Play Store and not to the GitHub repo builds. People might think that it's closed source if they don't dig into the Oxen GitHub.

  3. Installing on Linux - Not everyone uses Debian It's great seeing detailed install instructions for Lokinet on Linux, however I see they're written like Debian is the only Linux distro that people use. I'm not urging the devs to write detailed guides for every Linux distro there is, but at least including a link to how to compile from source would be nice.

This is it, I haven't found any more issue as of now. Please let me know if what I said makes sense 😆

KeeJef commented 3 years ago

Feel free to submit a PR with these changes

MassiveBox commented 3 years ago

Ok, I'll try to find some time, but do consider that whether your software is well documented or not does not matter to me, but does effect new users'opinion on the project. It would be in your best intrest to DIY.