Fixed .md files#926
Conversation
|
I've made some random changes here and there while reviewing the documentation(s) again, and I did make some small changes, a few hours after submitting the pull request. |
|
Hi, There are several points that need to be addressed before it can be merged. |
| ](https://github.com/electron-react-boilerplate/electron-react-boilerplate) | ||
|
|
||
| in a nutshell it's a GUI that interacts with [warp-plus](https://github.com/bepass-org/warp-plus/) binary and changes system proxy setting. | ||
| In a nutshell, Oblivion Desktop is a GUI program that interacts with "[WARP+](https://github.com/bepass-org/warp-plus/)"'s binary executable and changes the system's proxy settings. |
There was a problem hiding this comment.
Warp+ and Warp-Plus are two different concepts, and our reference in the text is specifically to the Warp-Plus repository.
You should not change it to Warp+ in this file or any other files.
There was a problem hiding this comment.
I will now fix all of the issues in the files
| ## Is Oblivion secure? | ||
|
|
||
| Both the Oblivion and Oblivion Desktop apps, as well as the Warp-Plus core, are open-source and their source code is | ||
| Both the Oblivion and Oblivion Desktop programs, as well as the WARP+ core, are open-source (FOSS) and their source code is |
There was a problem hiding this comment.
The term FOSS does not accurately apply to this program
| :white_check_mark: TUN <small>(with SingBox)</small> | ||
| :white_check_mark: Proxy <small>(No changes)</small><br> | ||
| :white_check_mark: System Proxy <small>(With PAC)</small><br> | ||
| :white_check_mark: TUN <small>(With [https://github.com/Chocolate4U/Iran-sing-box-rules](SingBox))</small> |
There was a problem hiding this comment.
The name sing-box must be written with a hyphen in all markdown files.
In this specific instance, it's also linked incorrectly, so the link should be removed.
| KDE | ||
| Gnome (gsettings)<br> | ||
| KDE (kio)<br> | ||
| GNU/Linux (glibc) |
There was a problem hiding this comment.
All changes made to the English section must also be reflected in the Persian section to avoid inconsistency in the content.
| - [Shabnam Font](https://rastikerdar.github.io/shabnam-font/) (Saber Rastikerdar) | ||
| - [Zag-NetStats](https://github.com/ShadowZagrosDev/Zag-NetStats) | ||
| - [and others 🧡](package.json) | ||
| - [And others! 🧡](package.json) () |
There was a problem hiding this comment.
What's the purpose of this extra parenthesis?
I'm not exactly sure what it's meant to do.
I've fixed all errors that you have pointed out in your review - I apologize for the mistakes made, you can review again to make sure everything is just fine if you'd like to. @ircfspace you can go ahead and merge if you believe this is good enough. |
| ## Is Oblivion secure? | ||
|
|
||
| Both the Oblivion and Oblivion Desktop apps, as well as the Warp-Plus core, are open-source and their source code is | ||
| Both the Oblivion and Oblivion Desktop programs, as well as the WARP-Plus core, are open-source (FOSS) and their source code is |
There was a problem hiding this comment.
The phrase "FOSS" is still present here and has not been removed
There was a problem hiding this comment.
All apologies, both mistakes have been corrected.
| <td>Method</td> | ||
| <td> | ||
| :white_check_mark: Warp & Warp+ <br> | ||
| :white_check_mark: WARP & WARP-Plus <br> |
There was a problem hiding this comment.
At this point, Warp+ was correct as an exception.
|
Thank you for your contribution, |
Description
LINK: https://github.com/coasteen/oblivion-desktop/
What does this change add to or fix in the project?
++ I've updated some of the documentation and markdown (.md) files for this project; trying to improve the documentation for it! Happy to help, I wish you're going to like it.
Checklist
Why this matters
These improvements will help:
[a] Make the project more accessible to non-native English speakers.
[b] Present a more professional image to potential users.
[c] Reduce confusion for new contributors.
NOTE: I've intentionally avoided modifying code of conduct or license files as those require maintainer discretion.
Happy to be contributing to my favorite project on GitHub! I am from Khuzestan.
++ As an open-source software enthusiast, I'm honored to contribute to this project. Please feel free to modify or adapt any of my changes - I'm happy to help make Oblivion Desktop even better!
(Feel free to check for "FOSS" mentionings and change them, I might have made a mistake; if this is not FOSS software.)