docs: developer guide by hpsing · Pull Request #21 · getoptimum/docs

hpsing · 2025-08-11T13:09:58Z

initial draft for the developer guide.
TODO:: will be addressed slowly as we progress and public GitHub examples are created.
@swarna1101 will address TODO:: in later PRs.
closes: docs: improvement and changes for hackathon #22

This reverts commit a3c62e8.

vercel · 2025-08-11T13:10:03Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
docs	Ready	Preview	Comment	Sep 2, 2025 8:13am

docs/guides/02-getting-started-docker.md

docs/learn/overview/p2p.md

docs/learn/overview/deram.md

docs/guides/02-getting-started-docker.md

docs/guides/05-faq-glossary.md

swarna1101 and others added 23 commits July 28, 2025 23:43

feat: enhance OptimumP2P documentation

90e5cff

fix: remove few things

fbbf757

fix: improve docs

ae7ca65

fix: lint

684ee92

feat: add hackathon docs

150f3ba

fix: link:

6f43b48

fix: minor change

5a08228

fix: add more details

b20d2b0

Add GossipSub configuration documentation

8dd859c

fix: docker version

a5c097b

Merge main branch with updated p2p.md and dependencies

2222907

Merge branch 'main' into hackathon-docs

d4d0e42

docs: Improve hackathon documentation structure and content

db37b9a

fix:lint

a3c62e8

Revert "fix:lint"

512d3c9

This reverts commit a3c62e8.

feat: Complete Task 3 client documentation and improve navigation

7ae62bf

fix: remove broken links

d4ca6b3

fix: gateway -> proxy

e57c442

feat: add protocol selection

25884e4

fix: remove dev setup ref and break the steps

7e633c9

fix: main and product page fixes

ee5718c

fix: guide for the cli

903c08e

docs: fix the pending docs

2c66cdc

hpsing requested a review from kishori82 August 11, 2025 13:09

hpsing self-assigned this Aug 11, 2025

hpsing added the documentation Improvements or additions to documentation label Aug 11, 2025

hpsing mentioned this pull request Aug 11, 2025

Hackathon docs #18

Closed

7 tasks

fix: improve the experiment guide

fd9edd9

vercel bot deployed to Preview August 14, 2025 06:28 View deployment

fix: img

5e4cbf3

vercel bot deployed to Preview August 22, 2025 09:30 View deployment

hpsing commented Aug 23, 2025

View reviewed changes

docs/guides/02-getting-started-docker.md Outdated Show resolved Hide resolved

hpsing commented Aug 23, 2025

View reviewed changes

docs/guides/02-getting-started-docker.md Outdated Show resolved Hide resolved

hpsing commented Aug 24, 2025

View reviewed changes

docs/learn/overview/p2p.md Show resolved Hide resolved

fix: remove keepalive ref and update the scripts

56d2304

vercel bot deployed to Preview August 25, 2025 09:35 View deployment

hpsing requested a review from kckeiks August 25, 2025 16:22

fix: add links in Optimum P2P overview page

63e2caa

vercel bot deployed to Preview August 26, 2025 07:34 View deployment