Skip to content

Add description authoring guide and update descriptions of higher level #55

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.

Sign up for GitHub

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

Merged
arscan merged 1 commit into from
Jul 29, 2025
Merged

Add description authoring guide and update descriptions of higher level #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ a preliminary test suite.
## Instructions

It is highly recommended that you use [Docker](https://www.docker.com/) to run
these tests. This test kit requires at least 10 GB of memory are available to Docker.
these tests. This test kit requires at least 10 GB of memory to be available to Docker.

- Clone this repo.
- Run `setup.sh` in this repo.
Expand All @@ -25,6 +25,15 @@ See the [Inferno Framework
Documentation](https://inferno-framework.github.io/docs/getting-started-users.html)
for more information on running Inferno.

## Description Authoring Guide

An experimental [Description Authoring
Guide](docs/description_authoring_guide.md) is available to assist developers
and LLMs in writing thorough and up-to-date descriptions for test
implementations. This guide provides detailed guidance on analyzing test code
and authoring accurate descriptions at all levels of the test hierarchy (test
kit, suite, group, and individual test levels).

## License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
Expand All @@ -41,4 +50,4 @@ specific language governing permissions and limitations under the License.
## Trademark Notice

HL7, FHIR and the FHIR [FLAME DESIGN] are the registered trademarks of Health
Level Seven International and their use does not constitute endorsement by HL7.
Level Seven International and their use does not constitute endorsement by HL7.
Loading