Skip to content

Conversation

hunterckx
Copy link
Collaborator

Closes #484

  • Outbreak descriptions are serialized for use with next-mdx-remote
  • As part of this, I've split build-catalog.ts into multiple files because I felt it was getting a bit too busy -- build-assemblies.ts, build-organisms.ts, and build-workflows.ts are all just existing code
  • I had to fix a couple issues with the outbreak definitions (escaping a < in the mpox description and fixing the description path for Plasmodium falciparum malaria)

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds support for serializing outbreak descriptions via next-mdx-remote while refactoring the catalog build process into separate files. Key changes include the fix for outbreak definition issues (escaping a “<” character and correcting a file path), splitting build-catalog.ts into modular files, and adding outbreak types to the common entities.

Reviewed Changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
catalog/source/outbreaks/mpox.md Fixed escaping for the “<” character in the mortality line.
catalog/source/outbreaks.yml Updated the path for the malaria outbreak definition.
catalog/build/ts/utils.ts Introduced new helper functions for file operations.
catalog/build/ts/build-workflows.ts Added workflow build logic.
catalog/build/ts/build-outbreaks.ts Added outbreak build logic using MDX serialization.
catalog/build/ts/build-organisms.ts Constructed organisms from genome data.
catalog/build/ts/build-catalog.ts Refactored to leverage new build modules.
catalog/build/ts/build-assemblies.ts Moved assembly-building logic from the consolidated file.
app/apis/catalog/brc-analytics-catalog/common/schema-entities.ts Exported outbreak priority and resource type enums.
app/apis/catalog/brc-analytics-catalog/common/entities.ts Added outbreak interfaces to the common entities.
Files not reviewed (1)
  • package.json: Language not supported
Comments suppressed due to low confidence (2)

catalog/source/outbreaks.yml:103

  • [nitpick] Confirm that the updated file name 'plasmodium_falciparum.md' is correct and consistent with the outbreak naming conventions used elsewhere in the project.
+      path: outbreaks/plasmodium_falciparum.md

catalog/source/outbreaks/mpox.md:13

  • Ensure that escaping the '<' character with a backslash is necessary for MDX serialization to render the content as intended. If not, consider removing the escape to improve readability.
+- **Mortality**: Case-fatality rate \<0.1% in non-endemic countries (2022), ~10% in Africa for more virulent clades

Copy link
Collaborator

@d-callan d-callan left a comment

Choose a reason for hiding this comment

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

i really like the refactored build files 🎉

@mvdbeek mvdbeek merged commit fc60bd5 into main Apr 30, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Outbreaks - Build the outbreaks.json file from the yaml and markdown
4 participants