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

Update documentation to follow table structure #61

Open
Relequestual opened this issue Jan 26, 2015 · 3 comments
Open

Update documentation to follow table structure #61

Relequestual opened this issue Jan 26, 2015 · 3 comments

Comments

@Relequestual
Copy link
Member

After taking a look at the Beacon Project protocol draft, I think the documentation found in this repo should be updated so that object properties are easier to read.

Using a table structure with the headings "Property, Required, Value, Description" results in documentation that as far easier to read. Any objects can be further defined and linked to, for example a Patient.

@sdumitriu
Copy link
Member

Hopefully the whole table will fit in the small width that GitHub provides for the content.

@buske
Copy link
Member

buske commented Mar 31, 2015

@Relequestual I hope you like the table in the manuscript. :)

@Relequestual Relequestual modified the milestone: Before v1.1 Apr 22, 2015
@Relequestual
Copy link
Member Author

I'd like to pick this task up, as it overlaps with some work I'll be doing in a few months time. Although happy for someone else to pick it up before I do, so I won't claim it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants