Skip to content

Commit 53d7cbc

Browse files
committed
feat(provider): add configuration section
1 parent 8309108 commit 53d7cbc

File tree

15 files changed

+562
-193
lines changed

15 files changed

+562
-193
lines changed

pages/api-ref/_meta.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

pages/api-ref/index.tsx

Lines changed: 0 additions & 3 deletions
This file was deleted.

pages/api-ref/provider/index.mdx

Lines changed: 0 additions & 1 deletion
This file was deleted.
File renamed without changes.

pages/getting-started/index.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Getting started
2+
3+
Welcome to the provider development documentation for Flixclusive! If you're here to learn about creating your own provider, you're in the right place. This comprehensive documentation will guide you through understanding how providers work under the hood and help you create your own.
4+
5+
## About this documentation
6+
7+
This documentation aims to provide:
8+
- Detailed technical information about provider architecture
9+
- Step-by-step guides for provider development
10+
- Best practices and patterns
11+
- Troubleshooting guides and common pitfalls
12+
- API references and examples
13+
14+
<Note>
15+
A significant portion of this documentation was generated using AI assistance. While we strive for accuracy and clarity, you may encounter issues or areas needing improvement. If you find any problems:
16+
- Create an issue in our [documentation repository](https://github.com/flixclusiveorg/provider-docs/issues)
17+
- Join our [Discord community](https://discord.gg/7yPSPveReu) for immediate assistance
18+
19+
Your feedback helps us maintain accurate and helpful documentation for all developers.
20+
</Note>
21+
22+
Let's begin your journey into provider development for Flixclusive!

pages/guides/getting-started/installation.mdx renamed to pages/getting-started/installation.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Installation
22

3+
This guide provides the steps how to initialize and prepare the required tools to create your own provider.
4+
35
## Prerequisites
46

57
Before you start creating a provider, ensure you have:
@@ -27,6 +29,9 @@ Before you start creating a provider, ensure you have:
2729

2830
1. Open `build.gradle.kts` in the root directory and update the placeholders for the main *author/s* and the *repository url*:
2931
```kotlin
32+
fun Project.flxProvider(configuration: FlixclusiveProviderExtension.() -> Unit)
33+
= extensions.getFlixclusive().configuration()
34+
3035
subprojects {
3136
// ...
3237

@@ -45,6 +50,9 @@ Before you start creating a provider, ensure you have:
4550
```
4651
2. If you wish to pre-configure and *automate* all package names or namespace for each provider, edit the namespace for every provider inside the same file you opened on the previous step:
4752
```kotlin
53+
fun Project.android(configuration: BaseExtension.() -> Unit)
54+
= extensions.getByName<BaseExtension>("android").configuration()
55+
4856
subprojects {
4957
// ...
5058

pages/guides/_meta.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

pages/guides/index.mdx

Lines changed: 0 additions & 10 deletions
This file was deleted.

pages/guides/provider/faq.mdx

Lines changed: 0 additions & 82 deletions
This file was deleted.

pages/guides/provider/index.tsx

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)