Skip to content

Internal Documentation System#46

Merged
EmeditWeb merged 2 commits into
StepFi-app:mainfrom
onajidavid87-web:build-protocol-documentation-embedded-viewer-
Jun 19, 2026
Merged

Internal Documentation System#46
EmeditWeb merged 2 commits into
StepFi-app:mainfrom
onajidavid87-web:build-protocol-documentation-embedded-viewer-

Conversation

@onajidavid87-web

Copy link
Copy Markdown
Contributor

Built a /docs page within the app so sponsors and vendors never leave the StepFi experience. Includes: 7 markdown doc sections: Introduction, Getting Started, For Sponsors, For Vendors, For Mentors, Smart Contracts, API Reference Sidebar navigation (src/components/docs/DocSidebar.tsx) — responsive with mobile overlay, icon-per-section Markdown rendering (src/components/docs/DocContent.tsx) — uses react-markdown + remark-gfm + rehype-highlight for GitHub-flavored markdown with syntax highlighting (dark theme) Contract addresses section with copyable IDs (displayed when viewing Smart Contracts) Quick links bar — chip-style buttons for jumping to key sections Client-side search — searches across all doc content, shows snippets with results count Footer "Docs" link updated from external docs.page to internal /docs New files: src/pages/Docs.tsx, src/components/docs/DocSidebar.tsx, src/components/docs/DocContent.tsx, src/docs/*.md (7 files), src/docs/shims.d.ts Modified files: src/router/index.tsx, src/components/layout/Footer.tsx, src/pages/Home.tsx npm run build — passes

Closes #28

Built a /docs page within the app so sponsors and vendors never leave the StepFi experience. Includes:
7 markdown doc sections: Introduction, Getting Started, For Sponsors, For Vendors, For Mentors, Smart Contracts, API Reference
Sidebar navigation (src/components/docs/DocSidebar.tsx) — responsive with mobile overlay, icon-per-section
Markdown rendering (src/components/docs/DocContent.tsx) — uses react-markdown + remark-gfm + rehype-highlight for GitHub-flavored markdown with syntax highlighting (dark theme)
Contract addresses section with copyable IDs (displayed when viewing Smart Contracts)
Quick links bar — chip-style buttons for jumping to key sections
Client-side search — searches across all doc content, shows snippets with results count
Footer "Docs" link updated from external docs.page to internal /docs
New files: src/pages/Docs.tsx, src/components/docs/DocSidebar.tsx, src/components/docs/DocContent.tsx, src/docs/*.md (7 files), src/docs/shims.d.ts
Modified files: src/router/index.tsx, src/components/layout/Footer.tsx, src/pages/Home.tsx
npm run build — passes

Closes StepFi-app#28
@EmeditWeb

Copy link
Copy Markdown
Member

fix ci issues

@EmeditWeb EmeditWeb merged commit 2f6e296 into StepFi-app:main Jun 19, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

core: build protocol documentation embedded viewer

2 participants