|
1 | 1 | import Tabs from '@theme/Tabs'; |
2 | 2 | import TabItem from '@theme/TabItem'; |
| 3 | +import DocCardList from '@theme/DocCardList'; |
3 | 4 |
|
4 | 5 | # Getting Started |
5 | 6 |
|
6 | | -Welcome to the Overture developer documentation. Here you will find comprehensive information on using our software microservices in a development context. Whether you're new to Overture or an experienced developer, this documentation will guide you through setup, usage, and best practices for our various services. |
7 | | - |
8 | | -## Core Software Structure |
9 | | - |
10 | | -Our core software documentation is organized to provide you with a clear and logical path through each service: |
11 | | - |
12 | | -``` |
13 | | -. |
14 | | -└── /Service/ |
15 | | - ├── /Overview |
16 | | - ├── /Setup |
17 | | - └── /Usage |
18 | | -``` |
19 | | - |
20 | | -### Overview |
21 | | - |
22 | | -The Overview section for each service typically includes: |
23 | | - - High-level overview of the service |
24 | | - - System architecture diagram and explanation |
25 | | - - Key features and capabilities |
26 | | - - Repository structure |
27 | | - - Links to relevant GitHub repositories or additional resources |
28 | | - |
29 | | -### Setup |
30 | | - |
31 | | -The Setup section runs you through the process of getting each service setup in a development environment. We offer guidance for the following Overture development configurations: |
32 | | - |
33 | | - |
34 | | -<Tabs> |
35 | | - <TabItem value="platform" label="Platform" default> |
36 | | -  |
37 | | - </TabItem> |
38 | | - <TabItem value="songDev" label="SongDev"> |
39 | | -  |
40 | | - </TabItem> |
41 | | - <TabItem value="scoreDev" label="ScoreDev"> |
42 | | -  |
43 | | - </TabItem> |
44 | | - <TabItem value="maestroDev" label="MaestroDev"> |
45 | | -  |
46 | | - </TabItem> |
47 | | - <TabItem value="arrangerDev" label="ArrangerDev"> |
48 | | -  |
49 | | - </TabItem> |
50 | | - <TabItem value="stageDev" label="StageDev"> |
51 | | -  |
52 | | - </TabItem> |
53 | | -</Tabs> |
54 | | - |
55 | | -:::info |
56 | | -For newcomers to Overture, we recommend starting with our Platform Quickstart and Platform Guides. Combined resources provide a comprehensive overview and hands-on experience with the Overture ecosystem. To begin your journey, [visit our Platform Guides](/guides/getting-started). |
57 | | -::: |
58 | | - |
59 | | -### Usage |
60 | | - |
61 | | -The Usage section provides detailed information on how to effectively use each service, including: |
62 | | -- Interacting with the API |
63 | | -- Common use cases and best practices |
64 | | -- Troubleshooting and FAQs |
65 | | -- Integration tips with other Overture services |
66 | | -- Performance optimization suggestions |
67 | | - |
68 | | -## Under Development |
69 | | - |
70 | | -Here we provide an overview of software currently under development and soon to be integrated into the Overture platform. |
71 | | - |
72 | | -## Other Software |
73 | | - |
74 | | -This section provides information on supplemental software that, while not directly integrated into the Overture platform, is part of the broader Overture project. Although primarily used for internal purposes, feel free to explore the documentation for these tools that support our open-source initiative. |
75 | | - |
76 | | -## Standards |
77 | | - |
78 | | -This section compiles the fundamental principles and established precedents that form the foundation of our Overture documentation and development practices. These standards ensure consistency and quality across our projects. |
79 | | - |
80 | | -## Support |
81 | | - |
82 | | -If you have any questions or need further assistance, please don't hesitate to reach out |
83 | | - |
84 | | -- For general questions, visit our [Community Forums](https://community.overture.bio/) |
85 | | -- For bug reports or feature requests, please use the respective GitHub repository's issue tracker. |
86 | | -- For enterprise support options, contact our team by email at contact@overture.bio. |
| 7 | +Our documentation is the definitive resource for the Overture project. Here you'll find comprehensive guides for implementing our software in development environments, up-to-date documentation on products under active development, technical standards, and additional resources. |
| 8 | + |
| 9 | +<DocCardList items={[ |
| 10 | + { |
| 11 | + type: 'link', |
| 12 | + label: 'Core Software', |
| 13 | + href: '/docs/core-software/', |
| 14 | + description: 'Overviews, Development Setups, and common usage' |
| 15 | + }, |
| 16 | + { |
| 17 | + type: 'link', |
| 18 | + label: 'Under Development', |
| 19 | + href: '/docs/under-development/', |
| 20 | + description: 'Software under development and soon to be integrated' |
| 21 | + }, |
| 22 | + { |
| 23 | + type: 'link', |
| 24 | + label: 'Other Software', |
| 25 | + href: '/docs/other-software/', |
| 26 | + description: 'Software that complements and supports Overture.' |
| 27 | + }, |
| 28 | + { |
| 29 | + type: 'link', |
| 30 | + label: 'Standards', |
| 31 | + href: '/docs/standards/', |
| 32 | + description: 'The formal basis of our Overture documentation and developement practices.' |
| 33 | + }, |
| 34 | + |
| 35 | +]} /> |
| 36 | + |
| 37 | +## Support & Contributions |
| 38 | + |
| 39 | +- For support, feature requests, and bug reports, please see our [Support Guide](https://main--overturedev.netlify.app/community/support). |
| 40 | + |
| 41 | +- For detailed information on how to contribute to this project, please see our [Contributing Guide](https://main--overturedev.netlify.app/docs/contribution). |
0 commit comments