IG Documentation Tips

With Sushi, you really don't have to do much to get the pages integrated into the IG but there are some conventions you must adhere to. Directories referenced in this document will all be children of the directory, input, from within the ncpi-fhir-ig working directory.

fsh -- Your various model files and related constructs images -- Drop any binary files here that aren't already present as a result of the publisher doing it's thing. That includes images as well as any other media that makes sense to embed into the IG pagecontent -- This is where you will find any markdown files that will be transformed into html files. All .md files in this directory are converted to html files, so that means you can add .md files that aren't referenced in the menu and link to them inside other pages. sushi-config.yaml -- This is the configuration for sushi to build the input to the publisher. I have opted to use the YAML syntax as part of this file for the menu, since it's much easier to maintain.

If you are new to markdown, this page may be helpful. I believe it's mostly the same as github's markdown, but there may be some slight differences.

For profiles, terminologies and other model specific content, there are two MD files that can be created which appear inline with the resource item's artifact page: intro and notes. To incorporate customized content into these pages, you must follow a simple naming scheme: {Resource Description}-{Resource Name}-{either note or intro}.md inside the pagecontent directory. For instance, to add information inside the notes section of the NCPI Phenotype resource's artifact page, I have created the file, pagecontent/StructureDefinition-ncpi-phenotype-notes.md file as well as the corresponding -intro file as well.