search

oss-slu / rerum-playground

A web-based set of tools for interacting with the objects that may exist in RERUM and all over the Internet.
MIT License
0 stars 6 forks source link

4 json and json ld documentation #9

Closed haydenkarl22 closed 1 month ago

haydenkarl22 commented 2 months ago

Fixes issue #4: Added JSON, JSON-LD, and JSON-LD @context handle documentation to JSON documentation READ ME file.

haydenkarl22 commented 1 month ago

Added

Thank you for working on this @haydenkarl22. The documentation you have generated is really good. You made it very clear and easy to understand. Great idea to include more resources at the end.

Here are few suggestions that could help us :

  • A website called json-ld playground that helps users understand how they work by comparing with the expanded form. If you think new users can benefit from that feel free to include it along with other resources.
  • Also I think it would be easier for users to navigate to pages if you could make the actual external resource links as hyperlinks.

I've considered the suggestions, and I agree they are good ideas, so I added them to the markdown document. The JSON-LD playground webpage is a link in the documentation, and all the links are now hyperlinks. I've also added padding to the text to make it easier to digest. This issue is ready for final review.