Skip to content

Commit 6c5d454

Browse files
[#51]: added tools sections. updated documentation
1 parent 035220b commit 6c5d454

3 files changed

Lines changed: 10 additions & 2 deletions

File tree

Doc/docs/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@ Currently, CortexFlow collects a limited set of metrics, but the team is activel
5555
This metric tracks the time taken for DNS queries to be resolved. It is a critical indicator of the performance of the DNS resolution process and helps ensure that the system is meeting its latency requirements.
5656

5757

58-
59-
The CortexFlow architecture is designed to be modular and extensible, allowing new components and features to be added as the system evolves. By leveraging Kubernetes and modern monitoring tools like Prometheus, CortexFlow ensures that the system remains resilient, scalable, and easy to manage. This architecture provides a solid foundation for building and deploying distributed systems that can handle high traffic loads while maintaining high availability and performance.
58+
The CortexFlow architecture is designed to be modular and extensible, allowing new components and features to be added as the system evolves. By leveraging Kubernetes and modern monitoring tools like Prometheus, CortexFlow ensures that the system remains resilient, scalable, and easy to manage.
6059

6160
---
6261

Doc/docs/tools/tools.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
CortexFlow incorporates a multitude of tools to help developers and users, giving them tools to test and use CortexBrain to the fullest. Thanks to these tools, CortexFlow makes the development and use of CortexBrain possible even for intermediate users.
2+
3+
## Testing Scripts
4+
5+
Being in the midst of development, the use of testing scripts to test the operation of the architecture is essential. Any developer who decides to participate in the development of CortexBrain can enjoy a different range of testing to test various features such as installation, uninstallation, connection, and vital functionality of the proxy. You can find the tests in this folder [Testing Scripts](https://github.com/CortexFlow/CortexBrain/tree/main/Scripts)
6+
7+
## CortexFlow Command Line Interface (CLI)
8+
CortexFlow CLI is a command line interface that allows users to interact with CortexBrain from the terminal and will start the development phase in April 2025. It will be designed to be a conduit between the user and the cluster by enabling the basic operations of installing and uninstalling, viewing metrics, and enabling the dashboard and all future CortexBrain components. You can monitor the development status of the tool through the branch [feature/cli](https://github.com/CortexFlow/CortexBrain/tree/feature/cli) .

Doc/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,5 @@ markdown_extensions:
5757
nav:
5858
- Home: index.md
5959
- Getting Started: installation/installation.md
60+
- Tools: tools/tools.md
6061
- Contact: contacts/contact.md

0 commit comments

Comments
 (0)