dimmyvi / tigress-requirements

Other
0 stars 3 forks source link

Attempt to improve readability of the document by #50

Closed ykarandikar closed 1 year ago

ykarandikar commented 1 year ago

-- moving a few sections around and removing redundant information. -- streamline use of general terms throughout the document. -- Cleaner example use cases with more inclusive names -- Removed sequence diagram of CarKey sharing using intermediary -- updated sequence diagram of sharing using intermediary to also cover CarKey case.

dimmyvi commented 1 year ago

As I mentioned in Slack, I suggest we break the PR down to smaller PRs - 1) moving existing text around, 2) editing existing paragraphs 3) adding new text This way it’s easier to review.

ykarandikar commented 1 year ago

As I mentioned in Slack, I suggest we break the PR down to smaller PRs -

  1. moving existing text around,
  2. editing existing paragraphs
  3. adding new text This way it’s easier to review.

As I responded on slack, it's not possible to convert this PR into 3 parts.

It addresses following fundamental issues with the existing document:

These issues can not be fixed with piecemeal PRs.

I can understand that it might be hard to read the diff. But I recommend reading the entire doc instead of trying to read the diff.