search

ove / ove-docs

Documentation repository for OVE
MIT License
1 stars 1 forks source link

OVE documentation #1

Closed dsigdosystem closed 5 years ago

dsigdosystem commented 6 years ago

Issue by davidbirchwork Friday Sep 07, 2018 at 13:39 GMT Originally opened as https://github.com/dsi-icl/ove/issues/7

Suggest using http://apidocjs.com/#getting-started to self document the API's for the apps and core

(a note for ove v0.2)

dsigdosystem commented 6 years ago

Comment by senakafdo Friday Sep 14, 2018 at 10:15 GMT

We also need to include the following documentation:

dsigdosystem commented 6 years ago

Comment by miguems Saturday Sep 15, 2018 at 17:48 GMT

Have there been any discussions on creating a user manual for each app/package? Maybe a good idea to also have a template for those.

dsigdosystem commented 6 years ago

Comment by senakafdo Monday Sep 17, 2018 at 01:39 GMT

@miguems, we did not discuss on apps as yet. Fully agree that those need to be documented as well.

dsigdosystem commented 6 years ago

Comment by davidbirchwork Tuesday Sep 18, 2018 at 10:30 GMT

Suggest we use API documentation compatible with https://swagger.io/ For .net API's https://github.com/domaindrivendev/Swashbuckle.AspNetCore will generate compatible doc and HTML viewers directly from code doc.

dsigdosystem commented 6 years ago

Comment by senakafdo Thursday Sep 20, 2018 at 21:01 GMT

All OVE core and OVE apps APIs are now documented using Swagger. To find an interactive listing of the APIs visit, http://{URL}/api-docs/ (works for OVE core and each app).

senakafdo commented 6 years ago

@jamesscottbrown, can you please fix the following in the SVG images used in INTRODUCTION.md:

  1. The sections on managing sections and managing state have images with non-equal physical dimensions and font-sizes making it look unprofessional.
  2. The font sizes of other images on this page are also not consistent.
  3. The images/tiling.svg has some text that are drawn insteaf of typed. Also the spacing of text have changed when ove.layout changed to ove.geometry.
  4. Only the top and left margins are set. The right and bottom margins are never set.
  5. What you have defined as x and y needs to be fixed to width and height. The images/tiling.svg as-is is misleading.
senakafdo commented 5 years ago

What's pending are:

  1. A design/architecture document/section explaining key components of OVE.
  2. Updates to SVG images on https://ove.readthedocs.io/en/latest/docs/BASIC_CONCEPTS.html.
  3. Tutorials on using OVE in real-world projects.
senakafdo commented 5 years ago

@jamesscottbrown will be updating the SVG images on https://ove.readthedocs.io/en/latest/docs/BASIC_CONCEPTS.html for the 0.4 release (the second point of the comment above).

Also, #19 will be addressing the third point of the comment above.

senakafdo commented 5 years ago

The remaining points on this issue are now addressed in #19 and #31. Therefore, I am closing this issue.