Skip to content

feat(docs): add interactive tutorial wizard + visual changelog page (#21, #14)#114

Open
DhruvGarg111 wants to merge 3 commits into
SynapseKit:mainfrom
DhruvGarg111:docs/production-checklist
Open

feat(docs): add interactive tutorial wizard + visual changelog page (#21, #14)#114
DhruvGarg111 wants to merge 3 commits into
SynapseKit:mainfrom
DhruvGarg111:docs/production-checklist

Conversation

@DhruvGarg111

@DhruvGarg111 DhruvGarg111 commented May 30, 2026

Copy link
Copy Markdown
Contributor

This PR implements two documentation improvements:

1. Interactive Getting Started Tutorial (#21)

  • Created a 5-step wizard-style tutorial in \docs/tutorial/\
  • Includes installation, RAG pipeline, agents with tools, graph workflows, and production deployment
  • Progress tracking and navigation between steps
  • 830+ lines of detailed content

2. Visual Changelog Page (#14)

  • Created \docs/changelog.md\ with a beautiful visual timeline
  • Version cards with number, date, key features, and type badges (Major/Minor/Patch)
  • Polished CSS styling with hover effects and full dark mode support
  • Added 'Changelog' link to the navbar

Both changes are complete and ready for review.

- Create docs/tutorial/ with 5-step wizard
- Add index.md and 5 detailed step pages (installation, RAG, agent, graph, deploy)
- Include progress tracking headers and navigation links
- Content is detailed, self-contained, and matches existing docs style

Addresses issue SynapseKit#21
- Add top-level 'Tutorial' category after Getting Started
- Link to tutorial/index and list all 5 steps
- Makes the new wizard discoverable from the main navigation

Part of issue SynapseKit#21
- Create docs/changelog.md with visual timeline, version cards, badges, and dates
- Add polished CSS styling for timeline and cards (light + dark mode)
- Add 'Changelog' link to navbar
- Addresses issue SynapseKit#14
@DhruvGarg111 DhruvGarg111 changed the title feat(docs): add interactive Getting Started tutorial wizard (#21) feat(docs): add interactive tutorial wizard + visual changelog page (#21, #14) May 30, 2026
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.

1 participant