This is an outline of the developer portal. This is not set in stone. Each section should be an individual page.
Use existing developer portals for inspiration:
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve
python3 -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
mkdocs serve
Provide basic code snippets in various languages. This should realistically be a single page with language tabs.
Available now:
- Python
- Swift
- Kotlin
- React Native (Typescript) (iOS + Android)
Future:
- Go
- Rust
- Typescript/Javascript
- nodejs
- web
- Dart
- Generating an “app key”
- Overview of “app metadata”
- Basic connect auth flow
- Approval/Rejection handling
- Calling SDK.Upload
- Using the progress callback
- Getting the object
- Calling SDK.Download using the object from the upload
- Calling share object with the uploaded object
- Expiration
- What it means to share a file
Explain concepts that developers might not be familiar with:
- What do they do?
- Why are they important?
- How do they help protect your privacy and your data?
- How do they make Sia secure, by default?
Our tutorials and quick start should link to these concepts and sections.
Simple usage examples that highlight the power of using Sia for decentralized storage.
Collaborate and decide on some use cases that are easy to build, understand, and familiar to developers that want cloud storage and are open to a decentralized alternative to traditional providers.
- TBD