Conversation
✅ Deploy Preview for highlighter-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello @jonochang, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new, dedicated documentation page that provides users with detailed instructions on how to export workflow-related data, such as CSV results and case files. It aims to centralize and clarify the data export process, making it easier for users to retrieve necessary information from their workflows. The new page is seamlessly integrated into the existing user manual structure through updated navigation links. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation page, exporting-workflow-data.md, which details how to export CSV results and case files from a workflow. It also adds links to this new page from the 'Managing Workflows' index and the 'Creating Workflow Orders' page. The new documentation is well-structured and provides useful details on export options, including how to customize ZIP file paths with templates. I have a couple of suggestions to improve clarity for the end-user, particularly around export requirements and template variable definitions.
content/docs/user-manual/managing-workflows/exporting-workflow-data.md
Outdated
Show resolved
Hide resolved
| - `WORKFLOW_ORDER_NAME`: Workflow order name (or workflow name if no order) | ||
| - `CASE_ID`: Case database ID | ||
| - `CASE_SHORT_ID`: Case short ID | ||
| - `CASE_EXTERNAL_ID`: External ID (entity, case, or short ID) |
There was a problem hiding this comment.
The description for CASE_EXTERNAL_ID is ambiguous as it lists multiple possible IDs ('entity, case, or short ID') without specifying the order of precedence. To help users predict the output of the template, please clarify the fallback logic. For example: '...uses the entity ID if available, otherwise the case ID, and finally the short ID'.
There was a problem hiding this comment.
See my similar comment in highlighter PR about this text in brackets
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
| draft = false | ||
| +++ | ||
|
|
||
| Export workflow data, including CSV results and case files: [Exporting Workflow Data](/docs/user-manual/managing-workflows/exporting-workflow-data/). |
There was a problem hiding this comment.
Not sure if this is desired results, see this page https://deploy-preview-73--highlighter-docs.netlify.app/docs/user-manual/managing-workflows/ has just this text at the top. All other content is just links
| @@ -0,0 +1,73 @@ | |||
| +++ | |||
There was a problem hiding this comment.
There is already a page for exporting data from workflows: https://deploy-preview-73--highlighter-docs.netlify.app/docs/user-manual/managing-workflows/exporting-data/, we should integrate this content into it
| - `WORKFLOW_ORDER_NAME`: Workflow order name (or workflow name if no order) | ||
| - `CASE_ID`: Case database ID | ||
| - `CASE_SHORT_ID`: Case short ID | ||
| - `CASE_EXTERNAL_ID`: External ID (entity, case, or short ID) |
There was a problem hiding this comment.
See my similar comment in highlighter PR about this text in brackets
2 participants
Related to https://github.com/silverpond/highlighter/pull/1011