Various documenation fixes #271
Conversation
* Fixed instructions * Added section * Fixed spelling * Fixed filename
WalkthroughThe recent updates focus on refining the documentation for running and configuring the Papercut SMTP service. Key changes include detailed instructions for running the service in a nearly portable manner, updating the configuration file name, and adding a new section on how to exit the service. These improvements aim to enhance user clarity and ease of use. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Outside diff range and nitpick comments (2)
README.md (2)
Line range hint
20-20: Correct heading levels for consistent document structure.- ### Host in Docker + ## Host in DockerTools
LanguageTool
[uncategorized] ~36-~36: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t.Service#readme). ### Host in Docker Optionally you can run Papercut SMTP Service in do...Markdownlint
31-31: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
Line range hint
46-46: Ensure fenced code blocks are surrounded by blank lines for proper Markdown formatting.+ > docker pull changemakerstudiosus/papercut-smtp:latest +Tools
LanguageTool
[uncategorized] ~36-~36: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t.Service#readme). ### Host in Docker Optionally you can run Papercut SMTP Service in do...Markdownlint
31-31: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- README.md (1 hunks)
- src/Papercut.Service/Readme.md (1 hunks)
Additional context used
LanguageTool
src/Papercut.Service/Readme.md
[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...
[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...README.md
[uncategorized] ~7-~7: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...est' emails are addressed to colleagues or worse, customers? Of course, you can se...
[style] ~10-~10: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...er (designed to receive messages only). Papercut SMTP doesn't enforce any restrictions o...
[uncategorized] ~10-~10: The grammatical number of this noun doesn’t look right. Consider replacing it. (AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
Context: ...email-chilada: body, HTML, headers, and attachment right down to the naughty raw encoded b...
[style] ~10-~10: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...t down to the naughty raw encoded bits. Papercut can be configured to run on startup and...
[style] ~16-~16: Consider an alternative verb to strengthen your wording. (IF_YOU_HAVE_THIS_PROBLEM)
Context: ... to be installed on your system. If you have any problems getting it running go to t...
[uncategorized] ~16-~16: A comma might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
Context: ...em. If you have any problems getting it running go to this site: [WebView2 Download](h...
[uncategorized] ~36-~36: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t.Service#readme). ### Host in Docker Optionally you can run Papercut SMTP Service in do...
Markdownlint
src/Papercut.Service/Readme.md
15-15: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank linesREADME.md
20-20: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time
16-16: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
6-6: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
9-9: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
12-12: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
13-13: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
15-15: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
19-19: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
20-20: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
20-20: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
22-22: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
22-22: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
24-24: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
24-24: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
26-26: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
26-26: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
28-28: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
28-28: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
31-31: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
45-45: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
52-52: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
39-39: Punctuation: ':' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
46-46: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
50-50: null (MD034, no-bare-urls)
Bare URL used
|
|
||
| A listing of all command line options are avaliable by entering: `Papercut.Service.exe help` | ||
| A listing of all command line options are avaliable 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. |
There was a problem hiding this comment.
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.
| _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...
| 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`). |
There was a problem hiding this comment.
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.
| - 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`). |
| 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. | ||
|
|
||
| ## How to Exit Papercut.Service |
There was a problem hiding this comment.
Add a blank line above the heading for proper Markdown formatting.
+
## How to Exit Papercut.ServiceCommittable 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.
| ## 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
|
|
||
| ## 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. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
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.
| 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...
| 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). |
There was a problem hiding this comment.
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.
| 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). |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- src/Papercut.Service/Readme.md (1 hunks)
Additional context used
LanguageTool
src/Papercut.Service/Readme.md
[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...
[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...
Markdownlint
src/Papercut.Service/Readme.md
15-15: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
Summary by CodeRabbit
Papercut.Service.