From 57eae8f25c18cd9212f581e7aa4d27c3f2145ef5 Mon Sep 17 00:00:00 2001 From: Philippe Matray Date: Tue, 20 Feb 2024 07:58:45 +0100 Subject: [PATCH] add FAQ to documentation --- docs/site/Writerside/redirection-rules.xml | 8 --- docs/site/Writerside/topics/FAQ.topic | 67 +++++++++++++++++-- docs/site/Writerside/topics/Reference.topic | 4 +- ...ception.CliCommandException(string,int).md | 23 +++++++ .../CliCommandException.ExitCode.topic | 25 +++++++ .../topics/technical/CliCommandException.md | 20 ++++++ docs/site/Writerside/web.tree | 4 +- 7 files changed, 135 insertions(+), 16 deletions(-) create mode 100644 docs/site/Writerside/topics/technical/CliCommandException.CliCommandException(string,int).md create mode 100644 docs/site/Writerside/topics/technical/CliCommandException.ExitCode.topic create mode 100644 docs/site/Writerside/topics/technical/CliCommandException.md diff --git a/docs/site/Writerside/redirection-rules.xml b/docs/site/Writerside/redirection-rules.xml index f2239f5..1d71309 100644 --- a/docs/site/Writerside/redirection-rules.xml +++ b/docs/site/Writerside/redirection-rules.xml @@ -6,12 +6,4 @@ page.html --> - - Created after removal of "Starter" from web - Starter.html - - - Created after removal of "Installation" from MasterCommander - Empty-MD-Topic.html - diff --git a/docs/site/Writerside/topics/FAQ.topic b/docs/site/Writerside/topics/FAQ.topic index e7489d9..7add7cc 100644 --- a/docs/site/Writerside/topics/FAQ.topic +++ b/docs/site/Writerside/topics/FAQ.topic @@ -2,11 +2,70 @@ + id="FAQ" title="Frequently Asked Questions (FAQ)" help-id="Alpha"> - FAQ + Frequently Asked Questions (FAQ) -

Start typing here...

+

This FAQ section addresses common questions and provides helpful answers about MasterCommander, covering its + features, usage, and more to ensure you get the most out of this versatile command-line utility.

+ +

MasterCommander is a command-line utility designed to streamline the workflow for developers working with + multiple technology stacks. It integrates common operations for Git, .NET, Docker, and npm into a single + application, enhancing productivity and simplifying project setup and management tasks.

+ + +

MasterCommander enhances productivity by providing a unified interface for interacting with various + development tools. It automates repetitive tasks and simplifies complex operations, allowing developers to + focus more on coding rather than switching between different command-line interfaces for different + tasks.

+ + +

Yes, MasterCommander is designed to be cross-platform, working seamlessly on Windows, macOS, and Linux. This + ensures that developers can use MasterCommander regardless of their preferred development environment.

+ + +

MasterCommander can be installed from source by cloning its repository and building the project using the + .NET CLI. It is also available as a NuGet package for integration into .NET projects. Detailed installation + instructions are provided in the section.

+ + +

Yes, MasterCommander is customizable and extensible, allowing developers to add new commands and features to + suit their specific workflows. This flexibility makes it a versatile tool that can adapt to various project + requirements.

+ + +

Yes, MasterCommander is open-source software licensed under the GPL-3.0-or-later license, making it free to + use, modify, and distribute. The source code is available on GitHub for anyone interested in contributing to + or extending its capabilities.

+ + +

Contributions to MasterCommander are welcome, whether they involve reporting bugs, suggesting improvements, + or submitting pull requests for new features or enhancements. Before contributing, please ensure you have + discussed the proposed changes with the project maintainers.

+ + +

Comprehensive documentation for MasterCommander is available on its GitHub repository. The + documentation covers all aspects of using MasterCommander, from getting started to exploring advanced + features.

+ + +

Bugs can be reported, and new features can be requested by submitting an issue to the MasterCommander GitHub repository. Please + provide as much detail as possible to help the maintainers understand and address the issue or feature + request.

+ + +

Yes, as an open-source tool licensed under the GPL-3.0-or-later license, MasterCommander can be used for + commercial projects. However, it's essential to comply with the terms of the license when using it in + commercial or proprietary software.

+

For any other questions or support, feel free to open an issue on the MasterCommander GitHub repository, and + the community or project maintainers will be happy to assist.

+ - + \ No newline at end of file diff --git a/docs/site/Writerside/topics/Reference.topic b/docs/site/Writerside/topics/Reference.topic index ab1fda1..2141af9 100644 --- a/docs/site/Writerside/topics/Reference.topic +++ b/docs/site/Writerside/topics/Reference.topic @@ -4,9 +4,7 @@ xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd" id="Reference" title="Reference"> - - Reference - + API Reference

Start typing here...

diff --git a/docs/site/Writerside/topics/technical/CliCommandException.CliCommandException(string,int).md b/docs/site/Writerside/topics/technical/CliCommandException.CliCommandException(string,int).md new file mode 100644 index 0000000..bb0688c --- /dev/null +++ b/docs/site/Writerside/topics/technical/CliCommandException.CliCommandException(string,int).md @@ -0,0 +1,23 @@ +#### [MasterCommander](MasterCommander.md 'MasterCommander') +### [MasterCommander.Core.Exceptions](MasterCommander.md#MasterCommander.Core.Exceptions 'MasterCommander.Core.Exceptions').[CliCommandException](CliCommandException.md 'MasterCommander.Core.Exceptions.CliCommandException') + +## CliCommandException(string, int) Constructor + +Initializes a new instance of the [CliCommandException](CliCommandException.md 'MasterCommander.Core.Exceptions.CliCommandException') class. + +```csharp +public CliCommandException(string? message, int exitCode); +``` +#### Parameters + + + +`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') + +The error message that explains the reason for the exception. + + + +`exitCode` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + +The exit code returned by the CLI command. \ No newline at end of file diff --git a/docs/site/Writerside/topics/technical/CliCommandException.ExitCode.topic b/docs/site/Writerside/topics/technical/CliCommandException.ExitCode.topic new file mode 100644 index 0000000..7c8d17a --- /dev/null +++ b/docs/site/Writerside/topics/technical/CliCommandException.ExitCode.topic @@ -0,0 +1,25 @@ + + + + + + + + + +

Gets the exit code associated with the CLI command failure.

+ + + public int ExitCode { get; } + + +

System.Int32

+ + + + \ No newline at end of file diff --git a/docs/site/Writerside/topics/technical/CliCommandException.md b/docs/site/Writerside/topics/technical/CliCommandException.md new file mode 100644 index 0000000..fdceb7e --- /dev/null +++ b/docs/site/Writerside/topics/technical/CliCommandException.md @@ -0,0 +1,20 @@ +#### [MasterCommander](MasterCommander.md 'MasterCommander') +### [MasterCommander.Core.Exceptions](MasterCommander.md#MasterCommander.Core.Exceptions 'MasterCommander.Core.Exceptions') + +## CliCommandException Class + +Represents an exception related to CLI command execution failures, including the associated exit code. + +```csharp +public class CliCommandException : System.Exception +``` + +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') 🡒 CliCommandException + +| Constructors | | +| :--- | :--- | +| [CliCommandException(string, int)](CliCommandException.CliCommandException(string,int).md 'MasterCommander.Core.Exceptions.CliCommandException.CliCommandException(string, int)') | Initializes a new instance of the [CliCommandException](CliCommandException.md 'MasterCommander.Core.Exceptions.CliCommandException') class. | + +| Properties | | +| :--- | :--- | +| [ExitCode](CliCommandException.ExitCode.topic 'MasterCommander.Core.Exceptions.CliCommandException.ExitCode') | Gets the exit code associated with the CLI command failure. | diff --git a/docs/site/Writerside/web.tree b/docs/site/Writerside/web.tree index 54174b4..7923314 100644 --- a/docs/site/Writerside/web.tree +++ b/docs/site/Writerside/web.tree @@ -15,6 +15,8 @@ - + + +