Stream: javascript
Topic: general
Dunmail (Nov 23 2015 at 14:11):
Conformance -> swagger.json -> auto-generated clients
nicola (RIO/SS) (Nov 23 2015 at 14:12):
yes, that's the goal!
nicola (RIO/SS) (Nov 27 2015 at 20:58):
@Josh Mandel may be transfer fhir.js to fhir-js organization?
Josh Mandel (Nov 27 2015 at 22:56):
Sounds like a good idea!
nicola (RIO/SS) (Nov 27 2015 at 22:58):
and fhirpath.js too :)
nicola (RIO/SS) (Nov 27 2015 at 23:00):
Then we can create beautiful entry page for all fhir js stuff, like HAPI :)
Ewout Kramer (Dec 01 2015 at 12:40):
Then we can create beautiful entry page for all fhir js stuff, like HAPI :)
Do you have a suggestion for a tool? We want to restructure our .NET documentation too, but are still looking for a publication platform... would not be a bad idea if we use the same stuff....currently we do files on github.io
nicola (RIO/SS) (Dec 01 2015 at 12:52):
I think, it would be github.io too
Ewout Kramer (Dec 01 2015 at 12:53):
AH yes, but are you going to write all pages by hand?
Ewout Kramer (Dec 01 2015 at 12:53):
Or is there some files + config and a renderer and then you upload to git
Ewout Kramer (Dec 01 2015 at 12:53):
Or, there is a website which monitors git, and rebuilds the doc if you push
nicola (RIO/SS) (Dec 01 2015 at 12:53):
some code-generation, with possible automation by travis.ci :)
Ewout Kramer (Dec 01 2015 at 12:54):
travis is a CI server, right? Will it generate documentation? I guess, from source files, but I also meant additional documentation with background info....
nicola (RIO/SS) (Dec 01 2015 at 12:55):
yes, travis is free for open source projects on github. https://gist.github.com/bewest/6100033
nicola (RIO/SS) (Dec 01 2015 at 12:55):
background info could be generated by tools like https://jekyllrb.com/
Josh Mandel (Dec 01 2015 at 15:45):
Yes: for static stuff there's Jekyll, which github.io natively supports/runs if you just put a config file in your repo.
Ewout Kramer (Dec 01 2015 at 16:05):
I am looking at readthedocs.com (and .org), which is used by quite some projects, including https://docs.asp.net/en/latest/
Ewout Kramer (Dec 01 2015 at 16:06):
Agree you could do this with jekyll, but I could not quickly find people who have written a template that looks nice and generates a nice hierarchical toc, a la readthedocs.com
Ewout Kramer (Dec 01 2015 at 16:08):
...and I don't speak Ruby, so I'd hope someone else already had done that job!
Josh Mandel (Dec 02 2015 at 04:12):
readthedocs is great! Very popular in the Python community.
Last updated: Apr 12 2022 at 19:14 UTC
