Skip to content

Conversation

@kaitj
Copy link
Collaborator

@kaitj kaitj commented Nov 21, 2024

Made a few quick changes to the checklist page stemming from feedback during previous tool review session - should help with the review process after checklist has been submitted.

  1. Moved the "export" and "import" buttons into separate modals. All the functionality remains same from there + a few additional buttons (see points 2 + 3). For both modals, an explicit "close" button is added, although it can also be closed just by clicking outside of the modal.
    image

  2. For exporting, "json" and "csv" options remain with an additional "copy" option, which copies the checklist to the clipboard. This should enable easier process of updating an existing checklist issue during the review process.
    image

  3. For importing, the option to import from json is still available. However, rather than immediately rendering the checklist, it first outputs it into the textarea. Alternatively, a user could also manually enter the checklist (or paste in an existing one), which should also make reviewing easier (i.e. copy json from issue and paste into text area here). One the upload button is pressed, the checklist is rendered.
    (note: comment about importing from URL has been dropped from the page.)
    image

Played around with the idea of a rendering from a URL and ultimately could still be something to be done. However, there was also discussion of adding evidence / comment free text fields, complicating what would already be a long url query parameter.

Here's a quick video demoing what this currently looks like:

nmind_checklist_demo.mp4

- Options to import include (1) from JSON File, (2) directly entered
  into the textarea.
Copies the checklist to keyboard, simplifying review process such that
the corresponding GH issue can be edited.
@kaitj kaitj self-assigned this Nov 21, 2024
@kaitj kaitj force-pushed the maint/checklist_import branch from a51a95b to f901922 Compare November 25, 2024 15:16
@kaitj
Copy link
Collaborator Author

kaitj commented Nov 25, 2024

@shnizzedy @effigies - would either of you have time to give this a quick look? Hoping to maybe get this in to make the review process easier.

Copy link
Member

@shnizzedy shnizzedy left a comment

Choose a reason for hiding this comment

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

I think this looks great.

A separate issue (this is the case despite this PR, just easier to notice after these changes), but I think worth handling:

If a user imports JSON, the relevant key-values are rendered, booleans are handled as truthy, and irrelevant key-values seem to be ignored (that all seems good to me). Then if/when the checklist is exported, the original non-validated inputs are included (extra keys, non-boolean truthy values). We might want to drop extra keys
and coerce types, either on import or before export. Or we might want to actually validate and reject JSONs that don't match the schema.

@kaitj kaitj merged commit 2f84610 into nmind:main Dec 9, 2024
1 check passed
@kaitj kaitj deleted the maint/checklist_import branch December 9, 2024 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants