ruby-api-stubs icon indicating copy to clipboard operation
ruby-api-stubs copied to clipboard

Missing API Documentation Images

Open DanRathbun opened this issue 3 years ago • 3 comments

Missing API Documentation Images

The following images are missing from the "images" subfolder of the stubs repo.

  • "entities-builder-grid-example.png"
  • "face-uv-tile-at.png"

(I had to manually copy them off the web and save it into my local stubs repository.)

Also, the embedded image links in the stubs suffer from not being a markdown image link per:

DanRathbun avatar Aug 11 '22 11:08 DanRathbun

As mentioned in #822, the doc comments are using RDoc, not Markdown. A remains of the old documentation that we've never had the time to reformat to Markdown. (Tried, but quickly snowballed - and not something you can partially migrate to.)

thomthom avatar Aug 17 '22 14:08 thomthom

Does not mean that you cannot include the image files in the repos "image" directory.

Meaning that this is a separate but related issue.

DanRathbun avatar Aug 18 '22 17:08 DanRathbun

As mentioned in #822, the doc comments are using RDoc, not Markdown.

As I mused in the API DOC Issue 822, Since this has to do with the Stubs output, not API Docs output, and since they have separate YARD templates, ... could this be corrected in the template for the stubs ?

DanRathbun avatar Oct 17 '22 23:10 DanRathbun