Update user guide with command format #129
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Revise the Features section of the user guide to include detailed command format explanations, adding clarity on command inputs in ContactSwift. Enhancements include instructions, cautionary notes, and usage tips to improve understanding and usability. Added visual cues and hyperlinked terms to the glossary to aid navigation and comprehension. These updates aim to make the guide more user- friendly and informative for effective utilization of ContactSwift's features.
hjungwoo01
added
documentation
Comment on lines
+9
to
+11
| Welcome to ContactSwift, the desktop app designed for efficient employee contact and task management. Optimized for use via a [Command Line Interface (CLI)](#cli-command-line-interface) while also providing a [Graphical User Interface (GUI)](#gui-graphical-user-interface), ContactSwift is ideal for small business owners, managers, and team leaders who aim to streamline their remote team’s workflows. | ||
|
|
||
| This guide will equip you with everything you need to maximize the benefits of ContactSwift, from initial setup to advanced features. |
Comment on lines
+27
to
+36
| ## How to Use This Guide | ||
|
|
||
| Navigate through this guide using the [Table of Contents](#table-of-contents). Icons and formatting are used throughout to signify different types of information: | ||
| - **Bold** for commands and important terms. | ||
| - *Italics* for notes and additional information. | ||
| - `Code` for actual input commands. | ||
|
|
||
| Check the [Glossary](#glossary) for explanations of technical terms to ensure a smooth learning experience with ContactSwift. | ||
|
|
||
| --- |
There was a problem hiding this comment.
Quite concise and well formatted
Comment on lines
+264
to
+265
| **Caution:** Deleting an employee is irreversible. Ensure you have selected the correct `INDEX`, `uid`, or `NAME` before proceeding. | ||
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Revise the Features section of the user
guide to include detailed command format
explanations, adding clarity on command
inputs in ContactSwift. Enhancements
include instructions, cautionary notes,
and usage tips to improve understanding
and usability. Added visual cues and
hyperlinked terms to the glossary to aid
navigation and comprehension. These
updates aim to make the guide more user-
friendly and informative for effective
utilization of ContactSwift's features.