Skip to content

Feat/savebook docs#260

Merged
HarshYadav152 merged 15 commits into
HarshYadav152:mainfrom
Muskankr:feat/savebook-docs
May 20, 2026
Merged

Feat/savebook docs#260
HarshYadav152 merged 15 commits into
HarshYadav152:mainfrom
Muskankr:feat/savebook-docs

Conversation

@Muskankr
Copy link
Copy Markdown
Contributor

SaveBook Documentation Website Using Docusaurus

Description

This PR adds a complete documentation website for the SaveBook project using Docusaurus.

The documentation site provides a clean, modern, and responsive developer guide with organized sections for setup, usage, contribution guidelines, deployment, and more.


Fixes #246


Features Implemented

  • Initialized Docusaurus documentation site
  • Added responsive and modern homepage UI
  • Added dark mode support
  • Added local search functionality
  • Configured sidebar navigation
  • Added SaveBook themed styling and branding
  • Added organized documentation pages
  • Added responsive layout for mobile devices
  • Added production-ready build configuration

Documentation Sections Added

  • Introduction
  • Project Overview
  • Features
  • Installation & Setup
  • Environment Variables
  • Usage Guide
  • Authentication Flow
  • API / Backend Information
  • Folder Structure
  • Deployment Guide
  • Contribution Guidelines
  • FAQ / Troubleshooting

Tech Stack

  • Docusaurus
  • React
  • Markdown
  • CSS

Checklist

  • Docusaurus initialized successfully
  • Sidebar navigation working
  • Responsive design implemented
  • Dark mode supported
  • Search functionality added
  • Documentation pages created
  • Production build tested successfully
  • No broken routes or major UI issues

Screenshots

Homepage

Screenshot 2026-05-18 011251

Mobile Responsive

Screenshot 2026-05-18 011304

Dark Mode

Screenshot 2026-05-18 012031

Thank you for reviewing my PR!

@vercel
Copy link
Copy Markdown

vercel Bot commented May 17, 2026

@Muskankr is attempting to deploy a commit to the Harsh Yadav's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Owner

@HarshYadav152 HarshYadav152 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Muskankr Move all documentation code inside in root docs/docusaurus-app and do not alter root docs/index.html

@HarshYadav152
Copy link
Copy Markdown
Owner

Also your branch is 27 commits behind from main.
Update it before do anything

@Muskankr Muskankr force-pushed the feat/savebook-docs branch from c2774c7 to 31748da Compare May 18, 2026 11:56
@Muskankr
Copy link
Copy Markdown
Contributor Author

@HarshYadav152

Updated PR based on review:

✔ Moved all documentation into docs/docusaurus-app as requested
✔ Restored root docs/index.html (no changes made)
✔ Rebased branch with latest main
✔ Resolved merge conflicts during rebase
✔ Updated branch successfully

Ready for review

@Muskankr Muskankr requested a review from HarshYadav152 May 18, 2026 12:00
Copy link
Copy Markdown
Owner

@HarshYadav152 HarshYadav152 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Muskankr You made it .

@HarshYadav152 HarshYadav152 added NSoC'26 Tells us this project is associated with Nexus Spring of Code level3 Level 3 issue for NSoC26 with 10 points labels May 20, 2026
@HarshYadav152 HarshYadav152 merged commit 900b1bd into HarshYadav152:main May 20, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

level3 Level 3 issue for NSoC26 with 10 points NSoC'26 Tells us this project is associated with Nexus Spring of Code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📚 [Docs] Create SaveBook Documentation Using Docusaurus

5 participants