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

Style guide #54

Open
RobertJCarroll opened this issue Sep 13, 2022 · 1 comment
Open

Style guide #54

RobertJCarroll opened this issue Sep 13, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@RobertJCarroll
Copy link
Contributor

We need to develop a style guide to ensure all of our contributions are consistent.

@liberaliscomputing liberaliscomputing added the documentation Improvements or additions to documentation label Sep 13, 2022
@torstees
Copy link
Collaborator

torstees commented Oct 5, 2022

@liberaliscomputing Some info that may be useful when you are working on this:

  1. When you create a file in pagecontent, when filenames are all lowercase, the header will be automagically altered to capitalize: So fhir_basics becomes Fhir Basics. To get FHIR to be all caps, that filename has to be FHIR_Basics.md (not sure the B is required)

  2. I find our prior approach to instances to be confusing and suggest we work with all pieces of a given "component" together. So, for my ResearchStudy example, I put the Study, Group, Patients and ResearchSubjects in a single file named Example-something-or-another.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

3 participants