Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: resolve laDefense.jpg #240

Open
jeremydouglass opened this issue Sep 27, 2017 · 5 comments
Open

Docs: resolve laDefense.jpg #240

jeremydouglass opened this issue Sep 27, 2017 · 5 comments

Comments

@jeremydouglass
Copy link
Member

This question is still open on processing-docs.

One solution is to revise the example code to point at laDefense.png (not jpg) and use this for the file taken from the Processing loadImage documentation

Processing.R docs affected with missing illustrations / tests include e.g. background

For discussion, see:

@jeremydouglass
Copy link
Member Author

@jeremydouglass
Copy link
Member Author

As per further conversation on the processing-docs issue, the original image is here:

https://acg.media.mit.edu/people/creas/representation/images/paris1.jpg

We won't be resizing, though -- better to use something that matches the ref img size, which is the default PDE minimum sketch size (100x100px), like

https://processing.org/reference/images/background_2.png

taken from:

https://processing.org/reference/background_.html

In general, the sketch code file name doesn't match the web reference file name--which is only an issue on our end because of how we do automated testing. So we can change our code, and/or our file name.

A bigger question is whether these images listed in .test.yml files should be added to the project repo rather than having remote urls (which can break).

@jeremydouglass jeremydouglass added this to the v1.0.8 milestone Aug 6, 2019
@jeremydouglass
Copy link
Member Author

jeremydouglass commented Aug 6, 2019

As an aside, I notice that we have some broken links related to this issue in the reference. In particular,

https://processing-r.github.io/reference/createImage.html

has broken links:

https://processing-r.github.io/reference/img/createImage1.png
https://processing-r.github.io/reference/img/createImage2.png

The images for building the reference are referenced in e.g.

https://github.com/processing-r/Processing.R/blob/master/examples/reference/createImage/createImage1/.test.yml

@gaocegege
Copy link
Member

Seems that we should rebuild the docs website.

@jeremydouglass
Copy link
Member Author

Great -- will rebuilding the docs website be part of the build instructions?

I see a script in the docs-tools repo, but I'm not sure what path takes for input and where should put its output.

https://github.com/processing-r/Processing.R-docs-tools/blob/master/scripts/generate-reference.sh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants