Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DocGen: add complex categories #126

Merged
merged 9 commits into from
Dec 12, 2024
Merged

DocGen: add complex categories #126

merged 9 commits into from
Dec 12, 2024

Conversation

Laren-AWS
Copy link
Contributor

Add complex categories as a separate YAML file that defines additional data for a category. The existing category field that uses a simple string is used as a key into the complex category table. The first use case for this is for tributaries that define custom categories and need to specify additional info about them. This also sets us up for expanding categories as needed in the future.

  • The category field in the main metadata can now be used as a key rather than a display value.
  • Categories contain a display field for their display value and a description field that can be joined with the display value to form a description.
  • Categories can also contain default and override specifications for title fields. Defaults are used when metadata does not contain these fields, overrides are always used.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@Laren-AWS Laren-AWS self-assigned this Dec 12, 2024
@Laren-AWS Laren-AWS requested a review from cpyle0819 December 12, 2024 18:51
@Laren-AWS Laren-AWS marked this pull request as ready for review December 12, 2024 18:52
@Laren-AWS Laren-AWS added the Enhancement A general update to the code base. label Dec 12, 2024
@Laren-AWS Laren-AWS merged commit 2b27f95 into main Dec 12, 2024
2 of 3 checks passed
@Laren-AWS Laren-AWS deleted the feat/semantic-categories branch December 12, 2024 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement A general update to the code base.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants