add FAQ to documentation

phmatray · Feb 20, 2024 · 57eae8f · 57eae8f
1 parent 6184b78
commit 57eae8f
Show file tree

Hide file tree

Showing 7 changed files with 135 additions and 16 deletions.
diff --git a/docs/site/Writerside/redirection-rules.xml b/docs/site/Writerside/redirection-rules.xml
@@ -6,12 +6,4 @@
         <accepts>page.html</accepts>
     </rule>
     -->
-    <rule id="2151c9a8">
-        <description>Created after removal of "Starter" from web</description>
-        <accepts>Starter.html</accepts>
-    </rule>
-    <rule id="2b7e601f">
-        <description>Created after removal of "Installation" from MasterCommander</description>
-        <accepts>Empty-MD-Topic.html</accepts>
-    </rule>
 </rules>
diff --git a/docs/site/Writerside/topics/FAQ.topic b/docs/site/Writerside/topics/FAQ.topic
@@ -2,11 +2,70 @@
 <!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
 <topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
-       id="FAQ" title="FAQ">
+       id="FAQ" title="Frequently Asked Questions (FAQ)" help-id="Alpha">
 
     <title>
-        FAQ
+        Frequently Asked Questions (FAQ)
     </title>
-    <p>Start typing here...</p>
+    <p>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.</p>
+    <chapter title="What is MasterCommander?" id="what-is-mastercommander">
+        <p>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.</p>
+    </chapter>
+    <chapter title="How does MasterCommander enhance productivity?" id="how-does-mastercommander-enhance-productivity">
+        <p>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.</p>
+    </chapter>
+    <chapter title="Can MasterCommander be used on any operating system?"
+             id="can-mastercommander-be-used-on-any-operating-system">
+        <p>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.</p>
+    </chapter>
+    <chapter title="How do I install MasterCommander?" id="how-do-i-install-mastercommander">
+        <p>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 <a href="Installing-MasterCommander.topic"/> section.</p>
+    </chapter>
+    <chapter title="Does MasterCommander support custom commands?" id="does-mastercommander-support-custom-commands">
+        <p>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.</p>
+    </chapter>
+    <chapter title="Is MasterCommander free to use?" id="is-mastercommander-free-to-use">
+        <p>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.</p>
+    </chapter>
+    <chapter title="How can I contribute to MasterCommander?" id="how-can-i-contribute-to-mastercommander">
+        <p>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.</p>
+    </chapter>
+    <chapter title="Where can I find documentation for MasterCommander?"
+             id="where-can-i-find-documentation-for-mastercommander">
+        <p>Comprehensive documentation for MasterCommander is available on its <a
+                href="https://github.com/phmatray/MasterCommander/blob/main/docs/README.md">GitHub repository</a>. The
+            documentation covers all aspects of using MasterCommander, from getting started to exploring advanced
+            features.</p>
+    </chapter>
+    <chapter title="How do I report a bug or request a new feature?"
+             id="how-do-i-report-a-bug-or-request-a-new-feature">
+        <p>Bugs can be reported, and new features can be requested by submitting an issue to the <a
+                href="https://github.com/phmatray/MasterCommander/issues">MasterCommander GitHub repository</a>. Please
+            provide as much detail as possible to help the maintainers understand and address the issue or feature
+            request.</p>
+    </chapter>
+    <chapter title="Can I use MasterCommander for commercial projects?"
+             id="can-i-use-mastercommander-for-commercial-projects">
+        <p>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.</p>
+        <p>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.</p>
+    </chapter>
 
-</topic>
+</topic>
diff --git 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">
 
-    <title>
-        Reference
-    </title>
+    <title>API Reference</title>
     <p>Start typing here...</p>
 
 </topic>
diff --git a/...terside/topics/technical/CliCommandException.CliCommandException(string,int).md b/...terside/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
+
+<a name='MasterCommander.Core.Exceptions.CliCommandException.CliCommandException(string,int).message'></a>
+
+`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.
+
+<a name='MasterCommander.Core.Exceptions.CliCommandException.CliCommandException(string,int).exitCode'></a>
+
+`exitCode` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')
+
+The exit code returned by the CLI command.
diff --git a/docs/site/Writerside/topics/technical/CliCommandException.ExitCode.topic b/docs/site/Writerside/topics/technical/CliCommandException.ExitCode.topic
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
+<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
+       id="CliCommandException.ExitCode"
+       title="CliCommandException.ExitCode">
+
+    <chapter title="MasterCommander" id="mastercommander">
+    </chapter>
+    <chapter title="MasterCommander.Core.Exceptions.CliCommandException"
+             id="mastercommander-core-exceptions-clicommandexception">
+    </chapter>
+    <chapter title="CliCommandException.ExitCode Property" id="clicommandexception-exitcode-property">
+        <p>Gets the exit code associated with the CLI command failure.</p>
+
+        <code-block lang="c#">
+            public int ExitCode { get; }
+        </code-block>
+        <chapter title="Property Value" id="property-value">
+            <p><a href="https://docs.microsoft.com/en-us/dotnet/api/System.Int32"
+                  summary="System.Int32">System.Int32</a></p>
+        </chapter>
+    </chapter>
+
+</topic>
diff --git a/docs/site/Writerside/topics/technical/CliCommandException.md 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') &#129106; [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') &#129106; 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
@@ -15,6 +15,8 @@
     <toc-element topic="How-Tos.topic">
         <toc-element topic="Create-a-NET-Console-Project.topic"/>
     </toc-element>
-    <toc-element topic="Reference.topic"/>
+    <toc-element topic="Reference.topic">
+        <toc-element topic="CliCommandException.ExitCode.topic"/>
+    </toc-element>
     <toc-element topic="FAQ.topic"/>
 </instance-profile>