Skip to content

IFA Updates - #52

Merged
datajohnson merged 57 commits into
ytgov:mainfrom
icefoganalytics:main
Mar 16, 2026
Merged

datajohnson merged 57 commits into
ytgov:mainfrom
icefoganalytics:main

Conversation

@datajohnson

Copy link
Copy Markdown
Collaborator

This pull request updates the documentation for agent workflows and planning in the Traditional Knowledge project. The main improvements are the addition of new comprehensive workflows for code review and testing instructions, consolidation and renaming of the Jira issue workflow, and restructuring of documentation for clarity and consistency. The changes ensure that multi-step guides for PR creation, code review, and issue management are clearly documented and easy to follow.

Workflow Documentation Improvements

  • Added a new code-review.md workflow detailing strict code review standards for TypeScript code, including step-by-step rules and output format. This is now step 2 in the complete PR creation sequence.
  • Added a new testing-instructions.md workflow for generating comprehensive testing instructions for pull requests. [1] [2] [3] [4]

Jira Workflow Consolidation

  • Replaced jira-issue-creation.md with jira-issue-management.md to cover creation, enhancement, and management of Jira issues. References and links throughout documentation have been updated for consistency. [1] [2] [3] [4] [5]

Documentation Structure and Usability

  • Updated agents/workflows/README.md to use a tabular format for available workflows and provide a clear step-by-step PR creation sequence, referencing new and updated workflows.
  • Added practical usage examples for each workflow, including PR creation, code review, and testing instructions, to improve onboarding and day-to-day usability.

Planning Documentation Updates

  • Simplified the agents/plans/README.md by removing the explicit plan table and clarifying naming conventions for plan files. Updated the last modified date. [1] [2]

Removed Deprecated Content

  • Deleted the obsolete jira-issue-creation.md workflow, consolidating its content into the new jira-issue-management.md.

These updates make the workflow documentation more comprehensive, easier to navigate, and better aligned with current project practices.

TODO: need to add dedicated back-end endpoint for creation ArchiveItem from ISA namespace.
Groups of items should be plural to denote that they are a group rather than a singular thing.
TODO: Add files and categoryIds to archive item creation.
Should use standardized nesting patterns for nested resources.
i.e.
{ filesAttributes } (if "files" associations on model)
Pattern taken from Rails-verse.
Need to implement in back-end.
Why? Help reduce coupling and make it clear that this "integration" interacts with an external entity (Azure Blob Storage).
Why? So we can keep front- and back-end version in sync.
(and hopefully process "true" and "false" as booleans correctly)
Always return an object, since this reduces the number of null and type checks we need.
…e objects.

Now uses Lodash to do the same thing.
Page level params will always be "string", but and then should be converted to "number".
Why? To hopefully let me use longer identifiers, so I don't have to rename a bunch of stuff.
informationSharingAgreementAccessGrants -> accessGrants.
Why? To fix this Sequelize query error:
The identifier that starts with 'informationSharingAgreementAccessGrants.ArchiveItemInformationSharingAgreementAccessGrant.informationSharingAgreementAccessGrant' is too long. Maximum length is 128.

I'm probably going to need to rename InformationSharingAgreement to SharingAgreement at some point.
Why? So we can correctly serialize the policy.
Note, this isn't a great fix, since the policy archiveItem is stale when serialized.
Also add archive item file destroy service.
You can't (and don't need to) delete entires from database "views".
Instead delete the data that feeds them.
Why? Easier to understand relationship.
How? Instead of relying on complex cascading services, we now do everything directly.

This reduces complexity, at the cost of future code maybe going out of sync between services.
Instead log only when job is doing something.
Otherwise show Create Knowledge Item link.
Make primary button dynamic based on whether knowledge item exists.
Remove "edit" call-to-action now that you can no longer edit signed agreements.
"revert to draft" is still present in the extended actions menu.
…-fields-from-isa-when-creating-knowledge-item

TK-28: Auto-fill Mandatory Fields from ISA When Creating Knowledge Item
@datajohnson
datajohnson merged commit 7ab06d7 into ytgov:main Mar 16, 2026
datajohnson pushed a commit that referenced this pull request Aug 28, 2026
TK-84: Use ISA Numbers in Knowledge Item Links
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