Skip to content

docs: add api-design.md and link from README Documentation section #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sulex45 merged 1 commit into from
Jun 29, 2026
+1 −6
Merged

docs: add api-design.md and link from README Documentation section #450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ This project is ideal for:
## Documentation

- [Getting Started Guide](docs/getting-started.md) - Set up the project and make your first API calls
- [API Design Guidelines](docs/api-design.md) — Explains StellarKit's response envelope, pagination conventions, asset shapes, timestamp formats, amount formats, and error structure.

---

Expand Down Expand Up @@ -189,12 +190,6 @@ StellarKit API currently supports Soroban contract inspection through the `/soro

---

## Documentation

- [API Design Guidelines](docs/api-design.md) — Explains StellarKit's response envelope, pagination conventions, asset shapes, timestamp formats, amount formats, and error structure.

---

## Getting Started

New to Stellar or this API? Start with the **[Getting Started Guide](docs/getting-started.md)** for step-by-step instructions. Also see the **[Glossary](docs/glossary.md)** for explanations of Stellar-specific terminology.
Expand Down
Loading