Skip to content

Commit

Permalink
adds TODOs for two missing nav menu icons
Browse files Browse the repository at this point in the history
  • Loading branch information
@jschuurk-kr
jschuurk-kr committed Aug 7, 2024
1 parent f7ca6be commit 02a1e6b
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions documentatie/flowcharts/date-entry-page.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Data Entry Page

## TODO
- add dash icon in "Render navigation menu" for forms with all fields filled with `0`
- add blue circle icon in "Render navigation menu" for forms that some field(s) filled in, but nothing submitted

## Questions
- Where does "cache input" happen in these flows?
- Is there a different warning icon for accepted versus not-accepted warnings? Or is it not possible to leave a page without accepting the warning? Also, accepting warnings is not yet included in any of the flows.
Expand Down

4 comments on commit 02a1e6b

@jorisleker
Copy link
Contributor

Choose a reason for hiding this comment

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

@jschuurk-kr attempt to make your diagram for the navigation menu a bit simpler. I think it's just these 6 statements, that should be evaluated for each menu item. Wouldn't that be easier then your flowchart? I ignored the 'illegal state', because I think that should be something you evaluate before even attempting to render the menu.

State of a menu-item:
Evaluate these top to bottom. The first one that evaluates to true is the state of the menu item

  • index of menu-item > furthers page user has seen: disabled (no icon, no link)
  • index of menu-item == current: current (arrow icon, bold, no link)
  • index of menu-item == furthes: 'unsubmitted' (blue dot)
  • page contains errors: error: error icon
  • page contains warnings and warnings have been accepted: warning: warning icon
  • submitted data was empty empty: dash icon

@jschuurk-kr
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jorisleker You're right that it can and should be simpler. Thanks!

I still prefer the flowchart. Some of that is personal preference, but by making a new one based on your description I realized the case "submitted data is not empty and valid" was missing from your description.

So I added that case to your description and put both your description and the new flowchart in a new commit. There are some interesting differences in choice of words between the two us, related to how this would be implemented. I think there's two options: maken it high-level enough to be independent from the implementation or update the doc after implementation.

Am curious what other people's preferences are about description vs flowchart. The flowchart is definitely linear enough that you don't lose much compared to a description.

@jorisleker
Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah I missed the most obvious case, nice catch.
No preference for text/diagrams. Diagrams are a lot easier to comprehend when logic isn't lineair. But harder to maintain (if you use the github web interface).

@jschuurk-kr
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I missed the most obvious case, nice catch.

teamwork! 💪 🙂

Please sign in to comment.