(FE) URL Spec

[devleejb]

What would you like to be added:

The task involves establishing a clear and comprehensive specification for the URL and slug that users will use to access the frontend.

Why is this needed:

In order to ensure a standardized approach and enhance user experience, it is essential to define the specifications for the URL that users will access on the frontend.

Additional Information:

• What Is a Slug?

[devleejb]

URL Specification

Login Page: /

• Note: Consider updating the URL when introducing a landing page in the future.

Workspace Page: /workspace/<workspace_slug>

Workspace Invitation: /join/<join_token>

Document Page: /document/<document_slug>

Shared Document Page: /document/<document_slug>?token=<share_token>

• Record share_token in the database and plan to log sharing options.

HackMD's URL Specification

Login Page: /login

Workspace Page:

• Default Workspace created upon signup: /?nav=overview
• User-created Workspace: /team/<workspace_url>?=nav=overview

Workspace Invitation: /join/<short_random_string>

• Generate a new short_random_string based on invitation link options (maximum invites, expiration period, etc.).

Document Page: /<document_id>

Shared Document Page:

• Read: /@<workspace_slug>/<shorter_document_id>
• Edit: /@<workspace_slug>/<shorter_document_id>/edit

Follow-up Tasks

• Implement logic for generating Workspace join_token and Document share_token.
  • (BE) Generate share and invitation token #76
  • Initially considered using JWT tokens but opted for shorter URLs.
• Implement Slug generation logic.
  • (BE) Generate slug for workspace and document #77
  • Generate slugs for workspace_slug, document_slug.
• Implement search logic using Slugs.
  • (BE) Generate slug for workspace and document #77

[devleejb]

New URL Specification

We have defined a new URL specification for the CodePair service, as outlined below:

• /: Service Main Page
• /login: Login Page
• /join/<join_token>: Workspace Invitation
• /<workspace_name>: Workspace Name
• /<workspace_name>/<document_id>: Document Detail
• /<workspace_name>/<document_id>/share?token=<share_token>: Document Detail - Share Mode

Follow-up Tasks

1. Enhanced User Registration:

   • Introduction of user name input during initial sign-up.
   • Implementation of duplicate checks between workspaces and usernames.
   • Prohibition of reserved keywords (e.g., join, login) for usernames.

2. Workspace Validation Upon Addition:

   • Inclusion of validation checks when adding a new workspace.
   • Implementation of duplicate checks between workspaces and usernames.
   • Prohibition of reserved keywords (e.g., join, login) for workspace names.

3. API Enhancement:

   • Transition from using the existing document_slug for API searches to utilizing document_id.

4. Frontend URL Specification Implementation:

   • Application of the newly defined URL specification to the frontend.