Skip to content

Fixed .md files#926

Merged
ircfspace merged 27 commits into
bepass-org:mainfrom
coasteen:main
Jun 2, 2025
Merged

Fixed .md files#926
ircfspace merged 27 commits into
bepass-org:mainfrom
coasteen:main

Conversation

@coasteen
Copy link
Copy Markdown
Contributor

@coasteen coasteen commented May 31, 2025

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

  • Some *.md files were updated
    • [+] README.md (A few spelling errors and some bad English problems here and there were fixed)
    • [+] CONTRIBUTING.md (I tried to improve this file a little bit and tried to include more information alongside fixing spelling errors)
    • [+] DOCS.md (This file was a little bit of a mess; I tried to organize it a little and tried to improve some of the grammar in this)
    • [+] FAQ.md (I took a basic look at the English part of this file and decided to improve some parts of it and fixed some English errors or others, and thought some improvements could benefit the file. Not a lot of changes)
    • [+] SECURITY.md (Fixed some typos and errors, nothing much changed.)
  • [*] Relevant documentation has been updated. (I have updated some of you amazing developers' documentation files for this program, while not touching any code of conduct files as they're not my job to handle.)

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.)

@coasteen
Copy link
Copy Markdown
Contributor Author

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.

@ircfspace
Copy link
Copy Markdown
Collaborator

Hi,
Thanks for taking the time and contributing to improve this repository.

There are several points that need to be addressed before it can be merged.
I'll leave comments on your changes so you can take care of them accordingly.

Comment thread DOCS.md Outdated
](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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will now fix all of the issues in the files

Comment thread FAQ.md Outdated
## 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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The term FOSS does not accurately apply to this program

Comment thread README.md Outdated
: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>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
KDE
Gnome (gsettings)<br>
KDE (kio)<br>
GNU/Linux (glibc)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All changes made to the English section must also be reflected in the Persian section to avoid inconsistency in the content.

Comment thread README.md Outdated
- [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) ()
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the purpose of this extra parenthesis?
I'm not exactly sure what it's meant to do.

@coasteen
Copy link
Copy Markdown
Contributor Author

coasteen commented Jun 1, 2025

Hi, Thanks for taking the time and contributing to improve this repository.

There are several points that need to be addressed before it can be merged. I'll leave comments on your changes so you can take care of them accordingly.

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.
Changes made: WARP+ back to WARP-Plus, "FOSS" removed, information in README.md synced with READMEfa.md, "SingBox" changed back to "Sing-Box," and other issues have been fixed.

@ircfspace you can go ahead and merge if you believe this is good enough.

Comment thread FAQ.md Outdated
## 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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrase "FOSS" is still present here and has not been removed

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All apologies, both mistakes have been corrected.

Comment thread README.md Outdated
<td>Method</td>
<td>
:white_check_mark: Warp & Warp+ <br>
:white_check_mark: WARP & WARP-Plus <br>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this point, Warp+ was correct as an exception.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

@ircfspace ircfspace merged commit 31a52fb into bepass-org:main Jun 2, 2025
@ircfspace
Copy link
Copy Markdown
Collaborator

Thank you for your contribution,
The changes have been merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants