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

docs: fix typos and grammar on pages #62

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/community/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ diverse, inclusive, and healthy community.
## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:
community includes:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
Expand Down Expand Up @@ -53,7 +53,7 @@ decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
This Code of Conduct applies within all community spaces and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
Expand Down
34 changes: 17 additions & 17 deletions docs/community/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ Xplorer is currently under development. We are welcoming contributors to collabo

There are many ways to contribute to Xplorer, and many of them do not involve writing any code. Here are few ideas to get started:

- Start using Xplorer! Go trough the Tutorial guides. Does anything work as expected? If not, we're always looking for improvements. Let us know by opening an issue.
- 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 making the docs better. File an issue if you find anything that is confusing, any grammatical error, or can be improved.
- 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.

Contributions are very welcome!

## Our development process

Xplorer uses [GitHub](https://github.com/kimlimjustin/xplorer) as its source of truth. The core team will be working directly there. All changes will be public from the beginning.
Xplorer uses [GitHub](https://github.com/kimlimjustin/xplorer) as its source of truth. The core team will be work directly there. All changes will be public from the beginning.

### Reporting new issues/bugs. {#issues}

Expand Down Expand Up @@ -54,7 +54,7 @@ Great Feature Requests tend to have:
1. After cloning the repository, run `yarn` in the root of the repository and run `yarn` in the `docs` folder (if you want to working on Xplorer Docs).
2. To start Xplorer locally, run `yarn start` in the root of the repository.

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

### Semantic commit messages {#commit-msg}

Expand All @@ -80,7 +80,7 @@ the various types of commits:
- `feat`: new feature for the user
- `fix`: bug fix for the user
- `docs`: changes to the documentation
- `style`: formatting, missing semi colons, etc.
- `style`: formatting, missing semi-colons, etc.
- `refactor`: refactoring production code, eg. renaming a variable
- `test`: adding missing tests, refactoring tests.
- `chore`: updating grunt tasks etc
Expand All @@ -89,7 +89,7 @@ Use lower case not title case!

## Working on Xplorer docs

Xplorer documentation website is built using [Docusaurus 2](https://docusaurus.io/), and its code is located is located at [`docs`](https://github.com/kimlimjustin/xplorer/tree/master/docs) folder.
Xplorer documentation website is built using [Docusaurus 2](https://docusaurus.io/), and its code is located at [`docs`](https://github.com/kimlimjustin/xplorer/tree/master/docs) folder.

### Prerequisite

Expand All @@ -100,11 +100,11 @@ Xplorer documentation website is built using [Docusaurus 2](https://docusaurus.i

### Installation

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

### Local development

1. Run `yarn start` command in the `docs` folder.
1. Run the `yarn start` command in the `docs` folder.
2. Edit some markdown texts in the `docs` folder and the website will be hot reloaded.

## Pull requests
Expand All @@ -117,15 +117,15 @@ Working on your first Pull Request? You can learn how from this free video serie

How to Contribute to an Open Source Project on GitHub

We have a list of [beginner friendly issues](https://github.com/kimlimjustin/xplorer/labels/good%20first%20issue) to help you get your feet wet in the DXplorer codebase and familiar with our contribution process. This is a great place to get started.
We have a list of [beginner-friendly issues](https://github.com/kimlimjustin/xplorer/labels/good%20first%20issue) to help you get your feet wet in the DXplorer codebase and familiar with our contribution process. This is a great place to get started.

### Proposing a change

If you would like to request a new feature or enchancement but are not yet thninking about opening a pull request, you can also [open an discussion](#feat) and others will code it!
If you would like to request a new feature or enhancement but are not yet thinking about opening a pull request, you can also [open a discussion](#feat) and others will code it!

If you intend to fixing a bug, please discuss it through [Issues](#issues) before submitting a pull request.
If you intend to fix a bug, please discuss it through [Issues](#issues) before submitting a pull request.

If you intend to add a new feature, please discuss it through [GitHub Discussion](#feat) to avoid multiple people working on a same feature request.
If you intend to add a new feature, please discuss it through [GitHub Discussion](#feat) to avoid multiple people working on the same feature request.

### Sending a Pull Request

Expand All @@ -141,7 +141,7 @@ make sure the PR does only one thing, otherwise please split it. It is recommend

We host our locales on the [crowdin](https://crwd.in/xplorer). To translate it, please follow these steps:

- SIgn up on [Crowdin](https://crowdin.com) and Join our project [here](https://crwd.in/xplorer).
- Sign up on [Crowdin](https://crowdin.com) and Join our project [here](https://crwd.in/xplorer).
- Make sure your locale exists there, if it does not exist, leave a comment in [this discussion](https://github.com/kimlimjustin/xplorer/discussions/30) and I'll add the language option :)
- Get familiar with the Crowdin translation UI, as you will need to use it to translate JSON and Markdown files
- Translate the content!
Expand All @@ -155,7 +155,7 @@ We host our locales on the [crowdin](https://crwd.in/xplorer). To translate it,

#### Production

Once the files on `src/Locales` have been translated for more than 80%, we will add it into Xplorer app, and for the docs, we will add it into production once the translation looks good!
Once the files on `src/Locales` have been translated for more than 80%, we will add it into the Xplorer app, and for the docs, we will add it into production once the translation looks good!

Please comment [here](https://github.com/kimlimjustin/xplorer/discussions/30) if you have any questions!

Expand All @@ -165,10 +165,10 @@ Files icons are available on [`src/icon`](https://github.com/kimlimjustin/xplore
You can add an icon by doing these steps:

- Paste the new icon in `src/icon`
- Edit value of [`src/config/icon.json`](https://github.com/kimlimjustin/xplorer/tree/master/src/config/icon.json)
- Edit the value of [`src/config/icon.json`](https://github.com/kimlimjustin/xplorer/tree/master/src/config/icon.json)

### File Type library

Files type library is available on [`src/config/type.json`](https://github.com/kimlimjustin/xplorer/tree/master/src/config/type.json).
The files type library is available on [`src/config/type.json`](https://github.com/kimlimjustin/xplorer/tree/master/src/config/type.json).

You can add type of a file extension by adding value on the file.
You can add the type of file extension by adding value to the file.
8 changes: 4 additions & 4 deletions docs/community/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
sidebar_position: 1
---
# Support
Xplorer is an open source project which you can freely join and seek support 😊.
Xplorer is an open-source project which you can freely join and seek support 😊.

On this page we've listed some communites/forums you can participate in to seek support or help others.
On this page, we've listed some communities/forums you can participate in to seek support or help others.

Before participating in Xplorer's communities, please read our [Code Of Conduct](../CODE_OF_CONDUCT).

Expand All @@ -21,7 +21,7 @@ Great Feature Requests tend to have:
- 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 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 Stackoverflow!

## News
FOr the latest news about Xplorer, you can see through the [official Xplorer blog](/blog) on this website.
For the latest news about Xplorer, you can see it through the [official Xplorer blog](/blog) on this website.
14 changes: 7 additions & 7 deletions docs/docs/guides/cli.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Launch Xplorer from Terminal

:::info
This feature hasn't optimized yet. It works but it might be laggy. Will be optimized in the feature release.
This feature hasn't been optimized yet. It works but it might be laggy. Will be optimized in the feature release.
:::

## Commands
Expand All @@ -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 any dir passed into the command, Xplorer will starts at Home page.
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.

Options:

Expand All @@ -30,10 +30,10 @@ Options:
Firstly, you have to register the command into the system path.

1. Open the `System Properties` on Windows.
2. Click the `Environment Variables` button, it will popup a window.
3. On the table, search for `Path` variable and click on it.
4. Click `Edit` button, it will popup a window.
5. Click `New` button
6. Add `%USERPROFILE%\AppData\Local\Programs\xplorer`
2. Click the `Environment Variables` button, it will pop up a window.
3. On the table, search for the `Path` variable and click on it.
4. Click the `Edit` button, it will pop up a window.
5. Click the `New` button.
6. Add `%USERPROFILE%\AppData\Local\Programs\xplorer`.

</details>
44 changes: 22 additions & 22 deletions docs/docs/guides/operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Copy files

You can copy files by right clicking it and click `Copy` option or select the file then press `Ctrl + C` as shortcut and paste it by clicking `Paste` option or press `Ctrl + V` on the destination folder.
You can copy files by right-clicking it and click the `Copy` option or select the file then press `Ctrl + C` as a shortcut and paste it by clicking the `Paste` option or press `Ctrl + V` on the destination folder.

:::info

On windows and macOS, Xplorer will copy the file paths into local clipboard, because of this, you can copy file from Xplorer and paste it into an folder in another system. However, on Linux, we create a string of Xplorer commands and copy it into user clipboard, Xplorer will read user's clipboard when pasting file (because we haven't found any idea to implement it, fell free to [open a PR](/community/Contributing/#pull-requests) if you can help us). The string of Xplorer command look like this:
On Windows and macOS, Xplorer will copy the file paths into the local clipboard, because of this, you can copy a file from Xplorer and paste it into any folder in another system. However, on Linux, we create a string of Xplorer commands and copy it into the user clipboard, Xplorer will read the user's clipboard when pasting the file (because we haven't found any idea to implement it, feel free to [open a PR](/community/Contributing/#pull-requests) if you can help us). The string of the Xplorer command looks like this:

```
Xplorer command - COPY
Expand All @@ -18,14 +18,14 @@ Xplorer command - COPY

## Copy Location Path

You can copy a file/folder location path into your clipboard by right clicking it and click `Copy Location Path` or select the file then press `Alt + Shift + C` as shortcut.
You can copy a file/folder location path into your clipboard by right-clicking it and click `Copy Location Path` or select the file then press `Alt + Shift + C` as a shortcut.

## Cut files

You can cut files by right clicking it and click `Cut` option or select the file then press `Ctrl + X` as shortcut and paste it by clicking `Paste` option or press `Ctrl + V` on the destination folder.
You can cut files by right-clicking it and click the `Cut` option or select the file then press `Ctrl + X` as a shortcut and paste it by clicking the `Paste` option or press `Ctrl + V` on the destination folder.

:::info
THis is done by creating a string of Xplorer command and copy it into user clipboard to be used when pasting file (not integrated with platform because we haven't found any idea, fell free to [open a PR](/community/Contributing/#pull-requests) if you can help us.). The string og Xplorer command look like this:
This is done by creating a string of Xplorer command and copies it into the user clipboard to be used when pasting file (this is not integrated with the platform because we haven't found any idea, feel free to [open a PR](/community/Contributing/#pull-requests) if you can help us.). The string of Xplorer command looks like this:

```
Xplorer command - CUT
Expand All @@ -37,29 +37,29 @@ E://test

## Delete files

You can cut files by right clicking it and click `Delete` option or select the file then press `Del` as shortcut. Trashed file can be accessed at `xplorer://Trash`.
You can cut files by right-clicking it and click the `Delete` option or select the file then press `Del` as a shortcut. The trashed file can be accessed at `xplorer://Trash`.

:::info

- On Windows, this is done by creating a `Trash` folder on `C:` drive and moving the file into it.
- On Linux, this feature is fully integrated with the sytem
- On Windows, this is done by creating a `Trash` folder on the `C:` drive and moving the file into it.
- On Linux, this feature is fully integrated with the system.
- On macOS, this is done by creating a `.local/Trash` folder on `homedir` and moving the file into it.

We are still working on Windows on macOS to integrate the `Trash` folder, will be released before the stable version came out. fell free to [open a PR](/community/Contributing/#pull-requests) if you can help us.
We are still working on Windows on macOS to integrate the `Trash` folder, which will be released before the stable version came out. Feel free to [open a PR](/community/Contributing/#pull-requests) if you can help us.

:::

### Permanently delete

:::danger
Permanently deleted file cannot be restored. Please check again before permanently delete any files.
A permanently deleted file cannot be restored. Please check again before permanently delete any files.

:::

You can permanently delete a file by:

1. Delete it into `Trash` and right clicking it and click the `Permanent Delete` option
2. Select the file and press `Shift + Del` as shortcut
1. Delete it into `Trash` and right-clicking it and click the `Permanent Delete` option
2. Select the file and press `Shift + Del` as a shortcut

## New

Expand All @@ -69,31 +69,31 @@ Xplorer treats `/` on file name/folder as subdir/subfile

### New file

You can create a new file by right clicking the workspace, expand the `New` option and select `file` option or press `Alt + N` as shortcut.
You can create a new file by right-clicking the workspace, expand the `New` option and select the `file` option, or press `Alt + N` as a shortcut.

### New folder

You can create a new folder by right clicking the workspace, expand the `New` option and select `folder` option or press `Shift + N` as shortcut.
You can create a new folder by right-clicking the workspace, expand the `New` option and select the `folder` option, or press `Shift + N` as a shortcut.

## Open file

You can open a file on default application by double-clicking it or select the file then press `Enter` as shortcut.
You can open a file on the default application by double-clicking it or select the file then press `Enter` as a shortcut.

### Open in Terminal

This is built-in function by Xplorer. You can open a folder on Terminal by right clicking it and click `Open in terminal` option or select the folder then press `Alt + T` as shortcut.
This is a built-in function by Xplorer. You can open a folder on Terminal by right-clicking it and click the `Open in terminal` option or select the folder then press `Alt + T` as a shortcut.

### Open in VSCode

This is built-in function by Xplorer. You can open a file/folder on VSCode by right clicking it and click `Open in vscode` option or select the file then press `Ctrl + Enter` as shortcut. You won't able to do this if you don't have VSCode installed.
This is a built-in function by Xplorer. You can open a file/folder on VSCode by right-clicking it and click the `Open in vscode` option or select the file then press `Ctrl + Enter` as a shortcut. You won't able to do this if you don't have VSCode installed.

## Pin to Sidebar

You can pin a file/folder into sidebar by right clicking it and click `Pin to Sidebar` or select the file then press `Alt + P` as shortcut.
You can pin a file/folder into the sidebar by right-clicking it and click `Pin to Sidebar` or select the file then press `Alt + P` as a shortcut.

## Preview file

You can preview a file directly from Xplorer by right-clicking it and click `Preview` otioin or select the file then press `Ctrl+O`.
You can preview a file directly from Xplorer by right-clicking it and click the `Preview` option or select the file then press `Ctrl+O`.

![Preview Demo](/img/docs/preview.png)

Expand Down Expand Up @@ -176,16 +176,16 @@ Files available to preview for now:

## Properties

You can view properties of a file/folder by right clicking it and click `Properties` or select the file then press `Ctrl + P` as shortcut.
You can view properties of a file/folder by right-clicking it and click `Properties` or select the file then press `Ctrl + P` as a shortcut.
Available properties for now (will be improved at the next version):

- Size
- File Path
- Created At
- Accesssed At
- Accessed At
- Modified At
- Is Hidden

## Rename file/folder

You can rename a file/folder by right clicking it and click `Rename` option or select the file then press `F2` as shortcut. It will prompt a dialog, enter the new name and the file/folder will be renamed.
You can rename a file/folder by right-clicking it and click the `Rename` option or select the file then press `F2` as a shortcut. It will prompt a dialog, enter the new name and the file/folder will be renamed.
Loading