You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/GETTING_STARTED.md
+25-10Lines changed: 25 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -4,37 +4,52 @@ Welcome to the **[Your Application Name]**! This guide will help you get started
4
4
5
5
## Table of Contents
6
6
1.[Introduction](#introduction)
7
-
2.[Getting Started Guides](#getting-started-guides)
7
+
2.[System Architecture](#system-architecture)
8
+
3.[Getting Started Guides](#getting-started-guides)
8
9
-[Product Owners](#product-owners)
9
10
-[Developers](#developers)
10
11
-[System Administrators](#system-administrators)
11
12
-[End-Users](#end-users)
12
-
3.[Additional Resources](#additional-resources)
13
-
4.[Feedback](#feedback)
13
+
4.[Additional Resources](#additional-resources)
14
+
5.[Feedback](#feedback)
14
15
15
16
## Introduction
16
17
[Your Application Name] is designed to [briefly describe the purpose and key features of the application]. This guide aims to provide you with the necessary resources to get started quickly and effectively.
17
18
19
+
## Architecture overview
20
+
For an overview of the system architecture, including components, relationships, and design decisions, please refer to our dedicated architecture document:
This document provides essential insights into how the application is structured and how its various parts interact.
25
+
18
26
## Getting Started Guides
19
27
20
-
### Product Owners
21
-
For Product Owners looking to understand the application's capabilities and how it aligns with business goals, visit the following guide:
22
-
-**[Getting Started Guide for Product Owners](link-to-po-guide)**
28
+
### Business Stakeholders
29
+
For Business Stakeholders looking to understand the application's capabilities and how it aligns with business goals, visit the following guide:
30
+
31
+
🏛️ **[Getting Started Guide for Business Stakeholders](link-to-business-stakeholders-guide)**
23
32
24
33
### Developers
25
34
If you're a Developer wanting to set up your development environment and contribute to the codebase, check out:
26
-
-**[Getting Started Guide for Developers](link-to-developer-guide)**
35
+
36
+
💻 **[Getting Started Guide for Developers](link-to-developer-guide)**
27
37
28
38
### System Administrators
29
39
System Administrators can find deployment and maintenance instructions in:
30
-
-**[Getting Started Guide for System Administrators](link-to-admin-guide)**
40
+
41
+
🧑🔧 **[Getting Started Guide for System Administrators](link-to-admin-guide)**
31
42
32
43
### End-Users
33
44
End-Users seeking to utilize the application effectively should refer to:
34
-
-**[Getting Started Guide for End-Users](link-to-user-guide)**
45
+
46
+
👥 **[Getting Started Guide for End-Users](link-to-user-guide)**
35
47
36
48
## Additional Resources
37
49
Explore more resources related to [Your Application Name]:
38
-
-[Documentation](link-to-docs)
50
+
-[Issue Tracker](link-to-issue-tracker)
39
51
-[Community Forum](link-to-forum)
40
52
-[FAQs](link-to-faqs)
53
+
54
+
## Feedback
55
+
We value your input! If you have suggestions or feedback on this guide or any of the linked resources, please let us know through our feedback form: [Feedback Form Link].
0 commit comments