-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: integrate docs for the SDK packages (#267)
## Motivation <!-- List motivation and changes here --> - integrates the docs for our SDK by reading them from node_modules - adds create-captain-app for that purpose - updates to the latest packages - renames the header links in the docs to "Core API" and adds "SDK" ## Issues closed <!-- List closed issues here -->
- Loading branch information
Showing
18 changed files
with
376 additions
and
37 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,3 @@ | ||
{ | ||
"README": "Overview" | ||
} |
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,3 @@ | ||
{ | ||
"README": "Overview" | ||
} |
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,3 @@ | ||
{ | ||
"README": "Overview" | ||
} |
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,3 @@ | ||
{ | ||
"README": "Overview" | ||
} |
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,3 @@ | ||
{ | ||
"README": "Overview" | ||
} |
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,8 @@ | ||
{ | ||
"index": "Overview", | ||
"create-captain-app": "Create Captain App", | ||
"utils": "@captn/utils", | ||
"theme": "@captn/theme", | ||
"react": "@captn/react", | ||
"joy": "@captn/joy" | ||
} |
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,38 @@ | ||
# Captain SDK Documentation Overview | ||
|
||
Welcome to the comprehensive SDK documentation for the Captain framework. Here you'll find all the resources needed to effectively use and extend the capabilities of Captain through our carefully designed SDKs. Each SDK package is tailored to meet the diverse needs of developers, empowering you to build robust, scalable, and customizable applications with ease. | ||
|
||
## Overview of SDK Packages | ||
|
||
Our SDK is divided into several key packages, each serving a specific role within the Captain ecosystem: | ||
|
||
- **`create-captain-app`**: Streamlines the creation of new Captain projects with customizable templates, supporting a range of web technologies. | ||
- **`@captn/joy`**: Provides UI components and utilities built on MUI Joy, enhancing the look and feel of your applications. | ||
- **`@captn/react`**: Offers a collection of React hooks tailored to integrate seamlessly with the Captain framework for efficient app development. | ||
- **`@captn/theme`**: Manages theming across Captain applications, ensuring consistent and appealing visual styles. | ||
- **`@captn/utils`**: Supplies essential utilities and helper functions that support the broader functionality of the Captain applications. | ||
|
||
## Quick Start Guide | ||
|
||
For developers new to Captain, each SDK package can be quickly integrated into your projects. Installation instructions, basic usage examples, and further details are provided within the individual package documentation linked below: | ||
|
||
- [Create Captain App Documentation](/captain-sdk/create-captain-app/README) | ||
- [@captn/joy Documentation](/captain-sdk/joy/README) | ||
- [@captn/react Documentation](/captain-sdk/react/README) | ||
- [@captn/theme Documentation](/captain-sdk/theme/README) | ||
- [@captn/utils Documentation](/captain-sdk/utils/README) | ||
|
||
## Community and Collaboration | ||
|
||
We're proud of our vibrant community and encourage collaboration and feedback. Engage with other developers, contribute to the SDK, and help us enhance the Captain experience: | ||
|
||
- **Discord**: [Join our community on Discord](https://discord.com/invite/m3TBB9XEkb) to share, learn, and collaborate. | ||
- **GitHub**: Visit our [GitHub repositories](https://github.com/blib-la/captn) to access the source code, report issues, or contribute. | ||
|
||
## Additional Resources | ||
|
||
For updates and enhancements, keep an eye on our [Changelog](https://github.com/blib-la/captn/blob/main/CHANGELOG.md) and explore additional resources to maximize your use of Captain. | ||
|
||
## Acknowledgments | ||
|
||
A heartfelt thanks to all our contributors and supporters who bring their passion and ideas to make the Captain framework what it is today. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
Oops, something went wrong.