Skip to content

About

This webapp mimics a virtual desk, where you can store accessible Sticky Notes in the cloud. A fun, 3d spin on a notes app.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Sticky3D Documentation

Welcome to the Sticky3D documentation! This folder contains technical guides and workflows for working with the project.

Documentation Index

🎥 Camera System

  • Camera System Technical Guide - Complete architecture of the camera system, including desk-relative alignment, dynamic clamps, spherical coordinates, and troubleshooting

📦 Prop Management

📋 Planning Documents


Quick Links

For implementing camera features: → See Camera System Technical Guide

For adding new props: → See Prop Onboarding Guide

For understanding the codebase: → See CLAUDE.md in the root directory

For recent changes: → See SPRINT_SUMMARY.md in the root directory


Documentation Standards

When to Update Docs

Camera System Technical Guide:

  • Camera alignment algorithm changes
  • New view modes added
  • Clamp calculation changes
  • New camera-related bugs discovered

Prop Onboarding Guide:

  • New prop processing features
  • Changed workflow steps
  • New override options
  • Additional prop requirements

Writing Style

  • Use clear, concise language
  • Include code examples
  • Provide troubleshooting sections
  • Link to related files with line numbers where applicable
  • Use emojis sparingly for section markers only

Contributing to Docs

When adding new documentation:

  1. Add the file to this docs/ directory
  2. Update this README.md with a link to the new doc
  3. Use markdown format (.md)
  4. Include a "Last Updated" date at the top
  5. Add a table of contents for docs > 200 lines

About

This webapp mimics a virtual desk, where you can store accessible Sticky Notes in the cloud. A fun, 3d spin on a notes app.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages