AOSSIE-Org / AOSSIE-Org/Agora-Blockchain

[Feature]: Developer Portal / Documentation Page

Open
#178 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
97
Forks
199
PR merge metrics
No merged PRs in 30d

Description

### Is there an existing issue for this?

- [x] I have searched the existing issues

### Issue Description ✍️

## 📌 Feature Description

Build a dedicated Developer Portal page offering comprehensive API docs, SDK downloads, integration guides, smart contract specs, and example apps to attract and support contributors.

## 📷 Screenshot

To be designed.
Layout ideas:

Clear navigation sidebar for docs sections

Searchable API reference with code snippets

Quickstart tutorials and troubleshooting tips

Links to GitHub repos and SDKs

## 💡 Suggestions

Use tools like Docusaurus or GitBook for docs hosting.

Auto-generate API docs from smart contract interfaces.

Embed live code playgrounds or sandbox environments.

Include contribution guidelines and roadmap.

Provide contact/support channels for devs.

### Record

- [x] I have synced all my node versions as mentioned in the project
- [x] I am using the same version of npm as is the project
- [x] My current branch is in sync with the development branch
- [x] I want to work on this issue

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.