[Documentation] Improve documentation
I'm going to use this comment to collect the general structure of the documentation and general format issues
General structure
The plan for improving the documentation is the following. The README will be left as it is since it already gives an overview of what the tool does. The sections that are going to be added are:
- One section for each format showing concrete examples of triplification in case of different arguments.
- A getting started section showing how to run the project and to start submitting queries (see #254)
- A video tutorial section which will collect pointers to videos
- Pointers to the showcases (see #253 )
- Resources as suggested by @enridaga in https://github.com/SPARQL-Anything/sparql.anything/issues/201#issuecomment-1121098338
- Details of the implementation, such as: SA components, workflows and instructions on how to contribute (e.g., implementing a new triplifier etc.)
- Examples of CLI options
Format issues
- Remove tables from format examples.
- Code blocks inside table cells inside details section ... some processors seem to not like that (e.g. the one of readthedocs.org)
I think we can leave this issue for any commit related to improvements in the docs
I'm going to use this comment to collect the general structure of the documentation.
The plan for improving the documentation is the following. The README will be left as it is since it already gives an overview of what the tool does. The sections that are going to be added are:
-
One section for each format showing concrete examples of triplification in case of different arguments.
-
A getting started section showing how to run the project and to start submitting queries
-
A video tutorial section which will collect pointers to videos Then, we have also point to the showcases
-
Resources as suggested by @enridaga in https://github.com/SPARQL-Anything/sparql.anything/issues/201#issuecomment-1121098338
-
Details of the implementation, such as: SA components, workflows and instructions on how to contribute (e.g., implementing a new triplifier etc.)
Cool, I would also add a section on resources with links to external material that may be relevant
Another thing to add in the guidelines is that example files need to be published at https://github.com/SPARQL-Anything/sparql-anything.cc-site.git in folder /root/examples/
In the last few commits I tried to clean the left side menu