-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add main docs README, docs badge (#157)
- Loading branch information
1 parent
94fe8fe
commit c937c4e
Showing
3 changed files
with
33 additions
and
4 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Lingua Documentation | ||
|
||
Welcome to the main documentation repository for **Lingua**. This directory provides a comprehensive guide to our tool, covering both its usage and underlying architecture. Here's a breakdown of the two main sections: | ||
|
||
## 1. [App - Usage & Best Practices](./App/) | ||
|
||
This section focuses on helping users effectively utilize "Your Tool Name". Here, you'll find: | ||
|
||
- **Usage Instructions**: Step-by-step guides on how to get started and utilize the main features of our tool. | ||
- **Best Practices**: Tips and recommendations for maximizing the utility and efficiency of **Lingua**. | ||
- ... and more! | ||
|
||
[📁 Click here to explore the App documentation](./App/) | ||
|
||
## 2. [Lingua Architecture](./Architecture/) | ||
|
||
Dive deeper into the design and structure of **Lingua** with our architecture documentation. This section provides insights into: | ||
|
||
- **System Design**: Understand the overall system layout and how different components interact. | ||
- **Technical Specs**: Details about the technologies used, data flow diagrams, and more. | ||
- ... and other technical insights! | ||
|
||
[📁 Click here to explore the Lingua Architecture documentation](./Architecture/) | ||
|
||
--- | ||
|
||
We encourage users to familiarize themselves with both sections to fully understand and utilize **Lingua** to its maximum potential. If you have further questions or feedback, please don't hesitate to reach out. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.