Skip to content

Commit

Permalink
chore: integrate docs for the SDK packages (#267)
Browse files Browse the repository at this point in the history
## 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
pixelass authored May 6, 2024
1 parent 7206a07 commit 5cda6b2
Show file tree
Hide file tree
Showing 18 changed files with 376 additions and 37 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,8 @@ homepage/pages/captain-core/client/ions
homepage/pages/captain-core/client/organisms
homepage/pages/captain-core/electron
homepage/pages/captain-core/shared
homepage/pages/captain-sdk/create-captain-app
homepage/pages/captain-sdk/joy
homepage/pages/captain-sdk/react
homepage/pages/captain-sdk/theme
homepage/pages/captain-sdk/utils
3 changes: 3 additions & 0 deletions homepage/pages/_captain-sdk/create-captain-app/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"README": "Overview"
}
3 changes: 3 additions & 0 deletions homepage/pages/_captain-sdk/joy/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"README": "Overview"
}
3 changes: 3 additions & 0 deletions homepage/pages/_captain-sdk/react/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"README": "Overview"
}
3 changes: 3 additions & 0 deletions homepage/pages/_captain-sdk/theme/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"README": "Overview"
}
3 changes: 3 additions & 0 deletions homepage/pages/_captain-sdk/utils/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"README": "Overview"
}
6 changes: 5 additions & 1 deletion homepage/pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@
}
},
"captain-core": {
"title": "Captain Core",
"title": "Core API",
"type": "page"
},
"captain-sdk": {
"title": "SDK",
"type": "page"
},
"marketplace": {
Expand Down
8 changes: 8 additions & 0 deletions homepage/pages/captain-sdk/_meta.json
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"
}
38 changes: 38 additions & 0 deletions homepage/pages/captain-sdk/index.mdx
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.
158 changes: 133 additions & 25 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 12 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,20 @@
"coverage:merge": "nyc merge ./coverage/merge ./coverage/combined-coverage.json",
"coverage:report": "nyc report --temp-dir ./coverage/merge --report-dir ./coverage/report --reporter lcov --reporter text",
"dev": "nextron",
"typedoc:generate": "run-s typedoc:client typedoc:electron typedoc:shared",
"typedoc:generate": "run-p typedoc:client typedoc:electron typedoc:shared typedoc:create-captain-app typedoc:captn-**",
"posttypedoc:generate": "node ./scripts/nextra-meta.mjs",
"typedoc:client": "run-s typedoc:client-atoms typedoc:client-ions typedoc:client-organisms",
"typedoc:client": "run-p typedoc:client-atoms typedoc:client-ions typedoc:client-organisms",
"typedoc:client-atoms": "npx typedoc --options typedoc.client-atoms.json",
"typedoc:client-ions": "npx typedoc --options typedoc.client-ions.json",
"typedoc:client-molecules": "npx typedoc --options typedoc.client-molecules.json",
"typedoc:client-organisms": "npx typedoc --options typedoc.client-organisms.json",
"typedoc:electron": "npx typedoc --options typedoc.electron.json",
"typedoc:shared": "npx typedoc --options typedoc.shared.json",
"typedoc:create-captain-app": "npx typedoc --options typedoc.create-captain-app.json",
"typedoc:captn-joy": "npx typedoc --options typedoc.captn-joy.json",
"typedoc:captn-react": "npx typedoc --options typedoc.captn-react.json",
"typedoc:captn-theme": "npx typedoc --options typedoc.captn-theme.json",
"typedoc:captn-utils": "npx typedoc --options typedoc.captn-utils.json",
"eslint": "eslint \"src/{**/*,*}.{ts,tsx}\"",
"postinstall": "electron-builder install-app-deps",
"ncu": "npx npm-check-updates@latest -u",
Expand Down Expand Up @@ -53,10 +58,10 @@
"sharp": "0.33.2"
},
"devDependencies": {
"@captn/joy": "^0.24.0",
"@captn/react": "^0.24.0",
"@captn/theme": "^0.24.0",
"@captn/utils": "^0.24.0",
"@captn/joy": "^0.26.2",
"@captn/react": "^0.26.2",
"@captn/theme": "^0.26.2",
"@captn/utils": "^0.26.2",
"@commitlint/cli": "^19.3.0",
"@commitlint/config-conventional": "^19.2.2",
"@dnd-kit/core": "^6.1.0",
Expand Down Expand Up @@ -104,6 +109,7 @@
"axios": "^1.6.8",
"conventional-changelog-cli": "^4.1.0",
"cpy-cli": "^5.0.0",
"create-captain-app": "^0.26.2",
"cross-env": "^7.0.3",
"dayjs": "1.11.11",
"docusaurus-plugin-typedoc": "^0.22.0",
Expand Down
Loading

0 comments on commit 5cda6b2

Please sign in to comment.