Skip to content

chore(docs): create ADR for client-side routing#1033

Merged
taymoor89 merged 10 commits intomainfrom
1022-create-routing-adr
Jul 11, 2025
Merged

chore(docs): create ADR for client-side routing#1033
taymoor89 merged 10 commits intomainfrom
1022-create-routing-adr

Conversation

@taymoor89
Copy link
Copy Markdown
Contributor

Summary

This PR add an ADR for client-side routing so other apps can add routing based on the same principals.

Changes Made

  • Created an ADR in docs

Related Issues

Screenshots (if applicable)

Testing Instructions

  1. pnpm i
  2. pnpm TASK

Checklist

  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • 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.
  • I have made corresponding changes to the documentation (if applicable).
  • My changes generate no new warnings or errors.
  • I have created a changeset for my changes.

PR Manifesto

Review the PR Manifesto for best practises.

@taymoor89 taymoor89 self-assigned this Jun 25, 2025
@taymoor89 taymoor89 added the documentation Improvements or additions to documentation label Jun 25, 2025
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jun 25, 2025

⚠️ No Changeset found

Latest commit: 807a0a5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@taymoor89 taymoor89 marked this pull request as ready for review June 25, 2025 14:48
@taymoor89 taymoor89 requested a review from a team as a code owner June 25, 2025 14:48
andypf
andypf previously approved these changes Jun 25, 2025
Copy link
Copy Markdown
Collaborator

@andypf andypf left a comment

Choose a reason for hiding this comment

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

👍

hodanoori
hodanoori previously approved these changes Jun 26, 2025
Copy link
Copy Markdown
Contributor

@hodanoori hodanoori left a comment

Choose a reason for hiding this comment

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

Thanks for preparing this ADR

TilmanHaupt
TilmanHaupt previously approved these changes Jun 26, 2025
Comment thread docs/decisions/004_client_side_routing.md
Comment thread docs/decisions/004_client_side_routing.md Outdated
@taymoor89 taymoor89 dismissed stale reviews from TilmanHaupt, hodanoori, and andypf via ca48fd3 June 30, 2025 08:22
ArtieReus
ArtieReus previously approved these changes Jun 30, 2025
Copy link
Copy Markdown
Collaborator

@ArtieReus ArtieReus left a comment

Choose a reason for hiding this comment

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

lgtm

hodanoori
hodanoori previously approved these changes Jun 30, 2025
Copy link
Copy Markdown
Contributor

@hodanoori hodanoori left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Copy Markdown
Contributor

@edda edda left a comment

Choose a reason for hiding this comment

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

Thank you! I like it!

Two things I would propose:

  1. add the info form your comment with the justification for the encode/decode utility to the ADR itself. I think it's very valuable additional information that helps understand the decision. Also a simple example of what encode and decode does could help
  2. Section 5. Route Definitions and UI State: a couple of examples would help understand this better, imo. So give an example for one or two routes coming out of the file-based routing, then give an example how they would change with an opened panel or modal.

TilmanHaupt
TilmanHaupt previously approved these changes Jul 10, 2025
@taymoor89 taymoor89 dismissed stale reviews from TilmanHaupt, hodanoori, and ArtieReus via 9fa3770 July 10, 2025 14:40
Comment thread docs/decisions/004_client_side_routing.md
Co-authored-by: Esther Schmitz <edda@users.noreply.github.com>
@taymoor89 taymoor89 merged commit 6c895b2 into main Jul 11, 2025
14 checks passed
@taymoor89 taymoor89 deleted the 1022-create-routing-adr branch July 11, 2025 07:29
andypf added a commit that referenced this pull request Jul 29, 2025
* chore(docs): create ADR for client-side routing

* chore(docs): add note for Tanstack router issue

* chore(docs): add examples and url-state-provider background

* chore(docs): update docs/decisions/004_client_side_routing.md

Co-authored-by: Esther Schmitz <edda@users.noreply.github.com>

* chore(docs): fix formatting

---------

Co-authored-by: Andreas Pfau <andreas.pfau@sap.com>
Co-authored-by: Esther Schmitz <edda@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants