Skip to content

[Refactor] Add slug-based document sharing and improve workspace sync handling#94

Merged
Gautam25Raj merged 1 commit into
masterfrom
refactor/slug-based-document-sharing-and-sync-system
May 24, 2026
Merged

[Refactor] Add slug-based document sharing and improve workspace sync handling#94
Gautam25Raj merged 1 commit into
masterfrom
refactor/slug-based-document-sharing-and-sync-system

Conversation

@Gautam25Raj
Copy link
Copy Markdown
Collaborator

Summary

This PR refactors the document sharing and workspace synchronization architecture by introducing stable slug-based sharing URLs, improving sync scoping behavior, and consolidating resume workspace storage handling.

The update also improves async feedback handling, document save reliability, and loading/error states across sharing workflows.

Refactor

Document Sharing System

  • Moved public share URLs to:
    • /share/:username/:slug
  • Added stable share slug behavior unless explicitly updated
  • Prevented slug collisions across renamed documents
  • Improved share link consistency and routing structure

Workspace & Sync Improvements

  • Scoped:
    • Sync outbox
    • Telemetry
    • Active document IDs
    • by document type
  • Preserved debounced resume save behavior and flush handling
  • Enhanced document sync service to support RESUME document type
  • Consolidated resume-related local storage handling into the document workspace service

Cleanup & Architecture

  • Removed deprecated:
    • Resume local storage service
    • Resume sync service
  • Simplified shared document persistence architecture
  • Improved maintainability across workspace-related systems

Improvements

Error & Loading Handling

  • Improved loading and error handling in share link services
  • Surfaced localStorage save failures instead of incorrectly reporting success
  • Enhanced async operation feedback consistency

Resume Data Handling

  • Updated resume schema to support optional title fields
  • Improved resume title formatting utilities
  • Enhanced title handling consistency across document flows

UI & Feedback

  • Added loadingText prop to Button component
  • Improved user feedback during async operations
  • Enhanced loading state clarity across actions

Beta Status

✅ Stability Improvements

  • Workspace synchronization and sharing flows are more stable
  • Improved document persistence reliability
  • Additional sync and sharing refinements are still expected

Notes

  • Beta-stage refactor release
  • Focused on document sharing reliability, sync architecture, and workspace consistency
  • Additional stabilization and workflow improvements expected in future beta releases

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📝 Documentation update
  • 🧪 Tests (adding or updating tests)

Checklist

  • I have read the CONTRIBUTING.md document.
  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.

- Move public share URLs to /share/:username/:slug
- Keep share slugs stable unless explicitly updated
- Avoid share slug collisions across renamed documents
- Scope sync outbox, telemetry, and active document ids by type
- Preserve debounced resume saves and flush behavior
- Surface localStorage save failures instead of reporting success
- Consolidated resume-related local storage operations into document workspace service.
- Removed deprecated resume local storage service and sync service.
- Enhanced document sync service to handle RESUME document type.
- Updated resume data schema to include optional title field.
- Improved resume title handling in formatting utilities.
- Added loading and error handling improvements in share link services.
- Introduced loading text prop in Button component for better user feedback during async operations.
@Gautam25Raj Gautam25Raj added enhancement New feature or request frontend UI/client-side code backend server-side logic api API-related changes or issues ui/ux Design or user experience improvements performance Performance improvements security Security concerns or fixes labels May 24, 2026
@Gautam25Raj Gautam25Raj linked an issue May 24, 2026 that may be closed by this pull request
@Gautam25Raj Gautam25Raj merged commit 6e3bbf7 into master May 24, 2026
1 check passed
@Gautam25Raj Gautam25Raj deleted the refactor/slug-based-document-sharing-and-sync-system branch May 27, 2026 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api API-related changes or issues backend server-side logic enhancement New feature or request frontend UI/client-side code performance Performance improvements security Security concerns or fixes ui/ux Design or user experience improvements

Projects

None yet

1 participant