Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Grammatical Error correction #105

Merged
2 changes: 1 addition & 1 deletion docs/blog/2021-08-09-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ tags: [xplorer, introduction, hello, blog]
I am very happy to introduce [Xplorer](https://xplorer.vercel.app) to help you organize your files/folders.

I created Xplorer for the following reasons:
* Support Multiple Tabs
* Supports Multiple Tabs
* Easy to use
* Highly customizable (just like VSCode)
* Cross-platform
Expand Down
12 changes: 6 additions & 6 deletions docs/community/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ There are many ways to contribute to Xplorer, and many of them do not involve wr
- Start using Xplorer! Go through the Tutorial guides. Does anything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
- Look through the [Xplorer issues](https://github.com/kimlimjustin/xplorer/issues). If you find an issue you would like to fix, [open a pull request](#first-pull-request). Issues tagged as [good first issue](https://github.com/kimlimjustin/xplorer/labels/good%20first%20issue) are a good place to get started.
- Help us make the docs better. File an issue if you find anything that is confusing, any grammatical error, or can be improved.
- Take a look at the [GitHub Discussion](https://github.com/kimlimjustin/xplorer/discussions) and give your opinion into a discussion or consider opening a pull request if you see something you want to work on.
- Take a look at [GitHub Discussions](https://github.com/kimlimjustin/xplorer/discussions) and give your opinion into a discussion or consider opening a pull request if you see something you want to work on.

Contributions are very welcome!

Expand All @@ -32,7 +32,7 @@ When [opening a new issue](https://github.com/kimlimjustin/xplorer/issues), alwa

### Feature Request {#feat}

We use [GitHub Discussions](https://github.com/kimlimjustin/xplorer/discussions) to track ideas from users. Suggest a new feature [here](https://github.com/kimlimjustin/xplorer/discussions)!
We use [GitHub Discussions](https://github.com/kimlimjustin/xplorer/discussions) to track ideas from users. Suggest a new feature [here](https://github.com/kimlimjustin/xplorer/discussions/new)!
Great Feature Requests tend to have:

- A quick idea summary.
Expand All @@ -47,7 +47,7 @@ Great Feature Requests tend to have:
- [Git](https://git-scm.com/)
- [yarn](https://yarnpkg.com/)
- [GCC Compiler](https://gcc.gnu.org/)
- Code Editor, we recommend to use [VS Code](https://code.visualstudio.com/)
- Code Editor, we recommend you to use [VS Code](https://code.visualstudio.com/)

### Installation

Expand All @@ -59,7 +59,7 @@ Great Feature Requests tend to have:

To start a local development server serving the Docusaurus docs, go into the `docs` directory and run `yarn start`

### Gitpod
### Gitpod {#gitpod-env}

Gitpod is a Ready-to-Code environment in which you can get started immediately. Gitpod offers all dependencies pre-installed so you can just click and get started.

Expand Down Expand Up @@ -111,13 +111,13 @@ Xplorer documentation website is built using [Docusaurus 2](https://docusaurus.i
- [node js](https://nodejs.org/en/)
- [git](https://git-scm.com/downloads)
- [yarn](https://yarnpkg.com/getting-started/install#about-global-installs)
- Code Editor, recommended [vscode](https://code.visualstudio.com/)
- Code Editor, we recommend you to use [VS Code](https://code.visualstudio.com/)

### Installation

After cloning the repository, run `yarn` in the `docs` folder (you can go into the `docs` folder by running the `cd docs` command).

If you want to use Gitpod, click here for the Gitpod Guide.
If you want to use Gitpod, click [here](#gitpod-env) for the guide on how to use Gitpod.

### Local development

Expand Down
10 changes: 7 additions & 3 deletions docs/community/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ On this page, we've listed some communities/forums you can participate in to see
Before participating in Xplorer's communities, please read our [Code Of Conduct](/community/CODE_OF_CONDUCT/).

## Issues
We use GitHub Issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. Report a bug by opening a new issue [here](https://github.com/kimlimjustin/xplorer/issues). Please use [GitHub Discussions](https://github.com/kimlimjustin/xplorer/discussions) instead to suggest a new feature.
We use GitHub Issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. Report a bug by opening a new issue [here](https://github.com/kimlimjustin/xplorer/issues/new). Please use [GitHub Discussions](https://github.com/kimlimjustin/xplorer/discussions) instead to suggest a new feature.

## GitHub Discussions
GitHub Discussions is used for multiple purposes, such as:
Expand All @@ -21,13 +21,17 @@ GitHub Discussions is used for multiple purposes, such as:


### Feature Request
We use [GitHub Discussions](https://github.com/kimlimjustin/xplorer/discussion) to track ideas from users. Suggest a new feature [here](https://github.com/kimlimjustin/xplorer/discussions)!
We use [GitHub Discussions](https://github.com/kimlimjustin/xplorer/discussion) to track ideas from users. Suggest a new feature [here](https://github.com/kimlimjustin/xplorer/discussions/new)!
Great Feature Requests tend to have:
- A quick idea summary.
- What & why you wanted to add the specific feature.
- Additional context like images, links to resources to implement the feature, etc.
### Help
You can ask for help using [GitHub Discussion](https://github.com/kimlimjustin/xplorer/discussions) and others will answer you, just like Stackoverflow!
You can ask for help using [GitHub Discussion](https://github.com/kimlimjustin/xplorer/discussions) and others will answer you, just like Stack Overflow!

:::note
Remember to choose the discussion category as Q&A so that your question will be published with answers enabled.
:::

## News
For the latest news about Xplorer, you can see it through the [official Xplorer blog](/blog) on this website.
8 changes: 4 additions & 4 deletions docs/docs/common_problems.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Common Problems

**NB: For installation common problems, please open [here](/docs/install/#common-problems)**
**NB: For common problems during installation, please open [here](/docs/install/#common-problems)**

<details>
<summary>
Expand All @@ -9,15 +9,15 @@

</summary>

Try open cmd by typing `Win + R` and type `cmd`.
Try opening `cmd` by opening <kbd>Win + R</kbd>(Run) and type `cmd`.

Enter following command:

```
wmic
```

If the output says the `wmic` is not recognized as internal or internal command, please follow following steps given on [this](https://superuser.com/questions/1178674/wmic-is-not-recognized-as-an-internal-or-external-command-operable-program-or) or [this](https://knowledge.informatica.com/s/article/156865?language=en_US). Also, please make sure that windows defender isn't blocking Xplorer from accessing your documents.
If the output says the `wmic` is not recognized as internal or internal command, please follow the following steps given on [this](https://superuser.com/questions/1178674/wmic-is-not-recognized-as-an-internal-or-external-command-operable-program-or) or [this](https://knowledge.informatica.com/s/article/156865?language=en_US). Also, please make sure that Windows Defender isn't blocking Xplorer from accessing your documents.

</details>

Expand All @@ -40,6 +40,6 @@ Also, please make sure that windows defender isn't blocking Xplorer from accessi
### Xplorer is unstable after installing it.

</summary>
Simply restart it will fix it, if it doesn't, please address an issue.
Simply restart, Xplorer will fix itself, if it doesn't, please address an issue [here](https://github.com/kimlimjustin/xplorer/issues/new).

</details>
2 changes: 1 addition & 1 deletion docs/docs/guides/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Xplorer CLI:
xplorer <options> [dir1] [dir2] [dir3]
```

Xplorer will open `dir`, `dir2`, `dir3` as tabs on Xplorer. If there's no dir passed into the command, Xplorer will start at the Home page.
Xplorer will open `dir`, `dir2`, `dir3` as tabs on Xplorer. If there's no directory(dir) passed into the command, Xplorer will start at the Home page.

Options:

Expand Down
10 changes: 5 additions & 5 deletions docs/docs/guides/setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ You can open settings on Xplorer by clicking the `Settings` button on the left d
</details>
<details>
<summary>
How to exit from the settings?
How to exit from Settings?
</summary>
You can exit from settings on Xplorer by clicking the Arrow Up button on the upside left of Xplorer.
You can exit from Settings on Xplorer by clicking the Arrow Up button on the upside left of Xplorer.

![Settings](/img/docs/exit-settings.png)

Expand Down Expand Up @@ -48,11 +48,11 @@ This will parse and cache the icon from a `exe` file and make it a preview. Only

![Extract Exe file icon](/img/docs/extract-exe-icon.png)

:::warning This might causes Xplorer crashes.
:::warning This might causes Xplorer to crash.

This is because Xplorer parse the icon from the exe and if the hexadecimal of the exe file broken, Xplorer crashes.
This is because Xplorer parses the icon from the exe and if the hexadecimal of the exe file is broken, Xplorer crashes.

Way to fix it: disable this setting
The way to fix it is to disable the setting.

:::

Expand Down
21 changes: 11 additions & 10 deletions docs/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,23 @@ sidebar_position: 2

## For Windows and MacOS

You can access the installer [here](https://github.com/kimlimjustin/xplorer/releases).
You can download Xplorer from the installer [here](https://github.com/kimlimjustin/xplorer/releases).

## For Linux

### AppImages

Grab **.AppImage** file in [releases](https://github.com/kimlimjustin/xplorer/releases) and follow this [Guide](https://docs.appimage.org/introduction/quickstart.html#how-to-run-an-appimage).
Grab the **.AppImage** file in the [releases](https://github.com/kimlimjustin/xplorer/releases) page and follow this [guide](https://docs.appimage.org/introduction/quickstart.html#how-to-run-an-appimage).

### Debian and Ubuntu based distros

Grab **.deb** file in [releases](https://github.com/kimlimjustin/xplorer/releases).
Grab the **.deb** file in the [releases](https://github.com/kimlimjustin/xplorer/releases) page.

You can install it by:
```bash
sudo dpkg -i /path/to/deb/file.deb
```

**or**

```bash
Expand All @@ -36,11 +37,11 @@ yay -S xplorer-bin

#or for manjaro

pamac build xplorer-bin
pacman build xplorer-bin
```
**or**

Grab **.pacman** file in [releases](https://github.com/kimlimjustin/xplorer/releases).
Grab the **.pacman** file in the [releases](https://github.com/kimlimjustin/xplorer/releases) page.

You can install it by:
```bash
Expand All @@ -49,7 +50,7 @@ sudo pacman -U /path/to/deb/file.pacman

**or**

build for [source](https://aur.archlinux.org/xplorer-bin.git)
build from [source](https://aur.archlinux.org/xplorer-bin.git)
```bash
git clone https://aur.archlinux.org/xplorer-bin.git

Expand All @@ -66,7 +67,7 @@ Faced Windows Defender?

This is actually not an error, it's a design choice by Microsoft to protect those of us who are not tech-savvy (i.e. potentially your friends) from a virus. You don't need to worry about the safety of Xplorer in this case since it's [open source](https://github.com/kimlimjustin/xplorer) and you can inspect the code or even build your own version!

To Handle this, you can just click the `More Info` button, then, just click Run Anyway.
To handle this, you can just click the `More Info` button, then, just click Run Anyway.

1. ![Step 1](/img/docs/windows-defender-1.png)
2. ![Step 2](/img/docs/windows-defender-2.png)
Expand All @@ -80,17 +81,17 @@ Adopted from [Stack Overflow](https://stackoverflow.com/questions/65488839/how-c
</details>
<details>
<summary>
`“Xplorer” cannot be opened because the developer cannot be verified. ` Error on macOS
<kbd>“Xplorer” cannot be opened because the developer cannot be verified.</kbd> Error on macOS
</summary>

Please try [this official docs](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac) by Apple.
Please try [the official docs](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac) by Apple.

</details>
<details>
<summary>
My favorite Installer is not here.
</summary>

Please address an issue [here](https://github.com/kimlimjustin/xplorer).
Please address an issue [here](https://github.com/kimlimjustin/xplorer/new).

</details>
4 changes: 2 additions & 2 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 1

## Summary

Welcome to xplorer! A Free and Open Source (FOSS) File Explorer.
Welcome to Xplorer, A Free and Open Source (FOSS) File Explorer.

Xplorer is a file explorer built from the ground up to be fully customizable and without customization, it also looks modern!
It is cross-platform, built using Electron Technology that allowed our File Explorer to be run not only in Windows but also Linux and MacOS alike.
Expand All @@ -20,4 +20,4 @@ So to summarize, Xplorer's features contain:
- Easy to use
- Cross-platform
- File Preview, even videos!
- Most importantly, it's Free and Open Source! Which mean you can change components inside if you see fit and you also don't make your wallet go dry
- Most importantly, it's Free and Open Source! Which mean you can change components inside if you see fit and you also don't need to make your wallet go dry or break the bank.