From d086905003a07533b2208fdaaca0ed4daa605746 Mon Sep 17 00:00:00 2001 From: NextTurn <45985406+NextTurn@users.noreply.github.com> Date: Wed, 25 Mar 2020 00:00:00 +0800 Subject: [PATCH] Fix typos --- CONTRIBUTING.md | 2 +- doc/developer/projectStructure.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 720cc50..510817e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,4 +29,4 @@ dotnet test src\Test\winswTests\winswTests.csproj ## Project Structure -You can find project structure guideline [here.](doc/developer/projectStructure.md) +You can find the project structure guideline [here](doc/developer/projectStructure.md). diff --git a/doc/developer/projectStructure.md b/doc/developer/projectStructure.md index d7d538d..8b76a8f 100644 --- a/doc/developer/projectStructure.md +++ b/doc/developer/projectStructure.md @@ -1,6 +1,6 @@ -# Project Structure +# Project structure -:movie_camera: [You can find code dive session recorede video here](https://youtu.be/_adhRj19ESY) +:movie_camera: You can find the code dive session recorded video [here](https://youtu.be/_adhRj19ESY). ``` |_ doc @@ -20,26 +20,26 @@ ## :open_file_folder: examples -This folder contains templates for configuration files. `sample-minimal.xml` contains a template for mandotory configurations and `sample-allOptions.xml` contains all possible configurations with documentation. +This folder contains templates for configuration files. *sample-minimal.xml* contains a template for mandatory configurations and *sample-allOptions.xml* contains all possible configurations with documentation. ## :open_file_folder: Core ## :notebook: ServiceWrapper -This is the main executable project. This contains the main.cs which is the entry point of the projet and contains some features for logging. +This is the main executable project. This contains the main.cs which is the entry point of the project and contains some features for logging. ### :page_facing_up: Main.cs -This file contains the entry point of the program (Main method). This file includes the main flow of the program and has implemented the logics for command line arguments. You can find more details about command line arguments [here.](https://github.com/winsw/winsw#usage) +This file contains the entry point of the program (Main method). This file includes the main flow of the program and has implemented the logics for command line arguments. You can find more details about command line arguments [here](../../README.md#usage). ## :notebook: WinSWCore -WinSW library is the main component of the project. This contains the most important logics of the project such as ServiceDescriptor.cs, Extension api and configurations etc. +This is the main component of the project. This contains the most important logics of the project such as ServiceDescriptor.cs, Extension api, configurations, etc. ### :page_facing_up: ServiceDescriptor.cs -This contains the logics for extracting configurations from XML file. `ServiceDescriptor` class get XML file as a argument. Currently configuratinos are provided on demand. +This contains the logics for extracting configurations from XML file. The `ServiceDescriptor` class gets XML file as an argument. Currently configuratinos are retrieved on demand. ## :open_file_folder: Configuration -This contains the interface for the configurations. `IWinSWConfiguration.cs` interface contains all configurations and `DefaultSettings.cs` contains default values for the configurations. +This contains the interface for the configurations. The `IWinSWConfiguration.cs` interface contains all configurations and `DefaultSettings.cs` contains default values for the configurations.