Skip to content

updated metadata template#34

Closed
edeyoung wants to merge 2 commits into
mainfrom
add_doc_outlines
Closed

updated metadata template#34
edeyoung wants to merge 2 commits into
mainfrom
add_doc_outlines

Conversation

@edeyoung

Copy link
Copy Markdown

Summary

Additional guidance for documentation

Testing Guidance

None

@edeyoung edeyoung requested a review from arscan March 25, 2025 13:42
@edeyoung edeyoung marked this pull request as draft March 25, 2025 13:42
@@ -1,3 +1,4 @@
module InfernoTemplate
VERSION = '0.0.0'.freeze
LAST_UPDATED = 'YYYY-MM-DD'.freeze # TODO: update next release

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This should be a real value. Note that this repo is really auto-generated from https://github.com/inferno-framework/inferno-core/blob/main/lib/inferno/apps/cli/templates/lib/%25library_name%25/metadata.rb.tt so we could update that to actually print out the current day.

Its fine for us to put a PR in this repo BTW as its easier to review, but to really 'persisit' it we'll need to put it in that template in inferno_core.

Comment thread lib/inferno_template/metadata.rb Outdated

E.g.:

> The ONC Certification (g)(10) Standardized API Test Kit is a testing tool for Health IT systems seeking to meet the requirements of the Standardized API for Patient and Population Services criterion § 170.315(g)(10) in the ONC Certification Program. It is an approved test method for the § 170.315(g)(10) test procedure.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I guess I would be a little more comfortable if we put in something like US Core in here vs. a certification test kit, just because publishing policy-looking documentation makes it look like official content vs. just an example. Or maybe just replacing it with a 'dummy' certification program / criteria. E.g. The Inferno Template Test Kit is a testing tool for Health IT systems seeking to meet the requirements of the API Criterion within the Example Certification Program.

Comment thread lib/inferno_template/metadata.rb Outdated
@@ -5,14 +5,89 @@ class Metadata < Inferno::TestKit
id :inferno_template
title 'Inferno Template'

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we should make all fields feel as real as possible. E.g. Inferno Example Test Kit. or 'Inferno Template Test Kit'.

@arscan

arscan commented Mar 25, 2025

Copy link
Copy Markdown
Contributor

Should this also follow through to the example suite, group, tests. And maybe high level README?

Oh sorry you only did one file to start, that's what you mean when you said 'this is only one file'. Disregard.

@Shaumik-Ashraf

Copy link
Copy Markdown
Contributor

These changes are now in #35

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.

3 participants