Kredex Docs

The official documentation for Kredex: P2P lending with on-chain reputation on Stellar.

Docs site · Live App · Product · Contracts · Discussions · X

---

🌱 The best place to make your first contribution

You don't need to know blockchain, Rust or React to improve documentation. If you can read and write, you can help. Fixing a typo or clarifying one confusing paragraph is a real, valued contribution, and we'll help you through your first pull request.

About

This repository is the source of the Kredex documentation site, built with Nextra (Next.js + MDX). It covers setup, architecture, smart contracts, usage guides, and the community feedback that shaped the product.

Ecosystem

Repo	Description
product	Web app (Next.js)
contracts	Soroban smart contracts
docs (you are here)	Documentation site
.github	Org policies and templates

Quick start

Prerequisites: Node.js 18+ and npm.

git clone https://github.com/kredex-org/docs.git
cd docs
npm install
npm run dev

Open http://localhost:3000. Pages hot-reload as you edit.

Command	What it does
npm run dev	Start the dev server
npm run build	Production build (run before opening a PR)
npm run start	Serve the production build

Project structure

docs/
├─ pages/
│  ├─ index.mdx               # Home
│  ├─ setup.mdx               # Setup guide
│  ├─ usage.mdx               # Using the platform
│  ├─ implementation.mdx      # Architecture and contracts
│  ├─ feedback-evolution.mdx  # Community feedback → product changes
│  ├─ _meta.ts                # Sidebar order and titles
│  └─ _app.jsx
├─ components/                # Reusable React components used in MDX
├─ theme.config.tsx           # Nextra theme (logo, footer, links)
└─ next.config.js

To add a page: create pages/my-page.mdx, then register it in pages/_meta.ts.

How to contribute

1. Read CONTRIBUTING.md for the writing guide and PR steps.
2. Pick a good first issue, or fix anything you noticed while reading.
3. Open a PR. We usually reply within a few days.

Ideas for first PRs: fix typos and grammar, add screenshots, write a "Troubleshooting" section, improve explanations for beginners, add a glossary (SEP-12, Soroban, escrow, soulbound NFT), translate pages.

Community & support

• 💬 Discussions
• 🐦 @kredexweb3
• 🔐 Security: see the Security Policy
• 📜 Code of Conduct

License

MIT