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.

Sign up for GitHub

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

Various documenation fixes #271

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Various documenation fixes #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9075116
Added linebreak and improved link
lwcorp Jun 11, 2024
155b07b
Update Readme.md
lwcorp Jun 11, 2024
f7fe6cd
Update src/Papercut.Service/Readme.md
Jaben Jun 11, 2024
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Papercut SMTP UI Requires the "WebView2" Microsoft shared system component to be
![Logging View](https://changemakerstudios.us/content/images/2020/07/Papercut-Log.png)

## Papercut SMTP Service
Papercut SMTP has an optional HTTP server to receive emails even when the client is not running. It's installed by default with [Papercut.Setup.exe](https://github.com/ChangemakerStudios/Papercut/releases).
Alternatively, it can be run in an almost portable way by downloading [Papercut.Service.zip](https://github.com/ChangemakerStudios/Papercut/releases), unzipping and [following the service installation instructions](https://github.com/ChangemakerStudios/Papercut/tree/develop/src/Papercut.Service).
Papercut SMTP has an optional HTTP server to receive emails even when the client is not running. It's installed by default with [Papercut.Setup.exe](https://github.com/ChangemakerStudios/Papercut/releases). \
Alternatively, it can be run in [an almost portable way](https://github.com/ChangemakerStudios/Papercut-SMTP/issues/248) by downloading [Papercut.Service.zip](https://github.com/ChangemakerStudios/Papercut/releases), unzipping and [following the service installation instructions](https://github.com/ChangemakerStudios/Papercut/tree/develop/src/Papercut.Service#readme).
Comment on lines +32 to +33
Copy link

Choose a reason for hiding this comment

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

Clarify the installation options for better understanding.

- Alternatively, it can be run in [an almost portable way](https://github.com/ChangemakerStudios/Papercut-SMTP/issues/248) by downloading [Papercut.Service.zip](https://github.com/ChangemakerStudios/Papercut/releases), unzipping and [following the service installation instructions](https://github.com/ChangemakerStudios/Papercut/tree/develop/src/Papercut.Service#readme).
+ Alternatively, for a nearly portable setup, download [Papercut.Service.zip](https://github.com/ChangemakerStudios/Papercut/releases), unzip it, and follow the [service installation instructions](https://github.com/ChangemakerStudios/Papercut/tree/develop/src/Papercut.Service#readme).
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Papercut SMTP has an optional HTTP server to receive emails even when the client is not running. It's installed by default with [Papercut.Setup.exe](https://github.com/ChangemakerStudios/Papercut/releases). \
Alternatively, it can be run in [an almost portable way](https://github.com/ChangemakerStudios/Papercut-SMTP/issues/248) by downloading [Papercut.Service.zip](https://github.com/ChangemakerStudios/Papercut/releases), unzipping and [following the service installation instructions](https://github.com/ChangemakerStudios/Papercut/tree/develop/src/Papercut.Service#readme).
Papercut SMTP has an optional HTTP server to receive emails even when the client is not running. It's installed by default with [Papercut.Setup.exe](https://github.com/ChangemakerStudios/Papercut/releases). \
Alternatively, for a nearly portable setup, download [Papercut.Service.zip](https://github.com/ChangemakerStudios/Papercut/releases), unzip it, and follow the [service installation instructions](https://github.com/ChangemakerStudios/Papercut/tree/develop/src/Papercut.Service#readme).


### Host in Docker

Expand Down
11 changes: 7 additions & 4 deletions src/Papercut.Service/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
## How to Run Papercut.Service

- Option 1:
Run from the command line by entering: `Papercut.Service.exe`
- Option 2: Install as a service with the command `Install-Papercut-Service.bat` and the service will be installed. Enter `Papercut.Service.exe install --sudo` to immediately start the service.
Run directly by running `Papercut.Service.exe`.
- Option 2: Install as a service by enering `Papercut.Service.exe install --sudo` to immediately start the service (you can easily create a shortcut for it and/or save it as `Install-Papercut-Service.bat`).
Copy link

Choose a reason for hiding this comment

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

Fix the typo in "entering".

- Install as a service by enering `Papercut.Service.exe install --sudo`
+ Install as a service by entering `Papercut.Service.exe install --sudo`
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Option 2: Install as a service by enering `Papercut.Service.exe install --sudo` to immediately start the service (you can easily create a shortcut for it and/or save it as `Install-Papercut-Service.bat`).
- Option 2: Install as a service by enering `Papercut.Service.exe install --sudo` to immediately start the service (you can easily create a shortcut for it and/or save it as `Install-Papercut-Service.bat`).
+ Option 2: Install as a service by entering `Papercut.Service.exe install --sudo` to immediately start the service (you can easily create a shortcut for it and/or save it as `Install-Papercut-Service.bat`).


A listing of all command line options are avaliable by entering: `Papercut.Service.exe help`
A listing of all command line options are available by running `Papercut.Service.exe help`.

## How to Configure Papercut.Service

_Papercut.Service_ does not need manual configuration. When the service and the client (_Papercut.exe_) processes are run at the same time, they will automatically synchronize their configurations. For example, when the SMTP settings is modified in the Papercut UI options, the service will automatically update itself and save these changes. Rule changes work the same way.
Copy link

Choose a reason for hiding this comment

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

Grammar correction needed for subject-verb agreement.

- For example, when the SMTP settings is modified in the Papercut UI options, the service will automatically update itself and save these changes.
+ For example, when the SMTP settings are modified in the Papercut UI options, the service will automatically update itself and save these changes.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
_Papercut.Service_ does not need manual configuration. When the service and the client (_Papercut.exe_) processes are run at the same time, they will automatically synchronize their configurations. For example, when the SMTP settings is modified in the Papercut UI options, the service will automatically update itself and save these changes. Rule changes work the same way.
_Papercut.Service_ does not need manual configuration. When the service and the client (_Papercut.exe_) processes are run at the same time, they will automatically synchronize their configurations. For example, when the SMTP settings are modified in the Papercut UI options, the service will automatically update itself and save these changes. Rule changes work the same way.
Tools
LanguageTool

[grammar] ~11-~11: “settings” is a plural noun. It appears that the verb form is incorrect. (PCT_PLURAL_NOUN_SINGULAR_VERB_AGREEMENT)
Context: ...ns. For example, when the SMTP settings is modified in the Papercut UI options, th...


If manual confiugration is needed, the configuration file for _Papercut.Service_ can be found in the same directory as the _Papercut.Service.exe_. `Papercut.Service.json` contains the configuration with comments outlining options. Note that any changes will require the service to be restarted to take effect.
If manual configuration is needed, the configuration file for _Papercut.Service_ can be found in the same directory as the _Papercut.Service.exe_. `Papercut.Service.Settings.json` contains the configuration with comments outlining options. Note that any changes will require the service to be restarted to take effect.
Copy link

Choose a reason for hiding this comment

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

Consider adding a comma after "options" for better readability.

- `Papercut.Service.Settings.json` contains the configuration with comments outlining options. Note that any changes will require the service to be restarted to take effect.
+ `Papercut.Service.Settings.json` contains the configuration with comments outlining options, note that any changes will require the service to be restarted to take effect.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
If manual configuration is needed, the configuration file for _Papercut.Service_ can be found in the same directory as the _Papercut.Service.exe_. `Papercut.Service.Settings.json` contains the configuration with comments outlining options. Note that any changes will require the service to be restarted to take effect.
If manual configuration is needed, the configuration file for _Papercut.Service_ can be found in the same directory as the _Papercut.Service.exe_. `Papercut.Service.Settings.json` contains the configuration with comments outlining options, note that any changes will require the service to be restarted to take effect.
Tools
LanguageTool

[uncategorized] ~13-~13: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...cut.Service.Settings.json` contains the configuration with comments outlining options. Note t...


## How to Exit Papercut.Service
Copy link

Choose a reason for hiding this comment

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

Add a blank line above the heading for proper Markdown formatting.

+
## How to Exit Papercut.Service
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## How to Exit Papercut.Service
## How to Exit Papercut.Service
Tools
Markdownlint

15-15: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines

If run as a client, just close the console window.