YASGUI: add some minimal Documentation

dracor-org / dracor-frontend

Frontend for the DraCor API

https://dracor.org

MIT License

4 stars 6 forks source link

YASGUI: add some minimal Documentation #45

Open ingoboerner opened 5 years ago

ingoboerner commented 5 years ago

Maybe we could come up with some minimal documentation to the SPARQL Endpoint and list some suggested Queries either on the YASGUI-Page itself (as does the ONB-SPARQL Interface https://labs.onb.ac.at/en/tool/sparql/ – same Implementation, by the way...) @lehkost ?

lehkost commented 5 years ago

Yes, documentation with examples would be great. Maybe add a new repo documentation and use Markdown, which could then be mirrored to our website via GH pages? We're also trying to find out where best to put our R Notebooks with API query examples, so we might have to have a general discussion within the group. (@mathias-goebel @cmil @Pozdniakov)

cmil commented 5 years ago

Generally I would recommend to keep the documentation close to the code, to increase chances it gets updated whenever the code changes. So maybe in this case dracor-schema, where the ontology is maintained, would be appropriate?