search

nasa-fornax / fornax-documentation

Documentation for Fornax Science Console.
https://nasa-fornax.github.io/fornax-demo-notebooks/#user-documentation
BSD 3-Clause "New" or "Revised" License
2 stars 3 forks source link

Move screenshots into a subdirectory #11

Closed troyraen closed 5 months ago

troyraen commented 5 months ago

I like the screenshots and think they add clarity. Just wondering about putting them in a subdirectory so they're not all in the repo root? I think it's easier to manage that way and makes the repo contents more clear.

troyraen commented 5 months ago

My original instinct was to use images but that seemed unclear because of all the name collisions (is this Docker images, CCD images, science plots/figures, ...?). But maybe because this repo is strictly documentation it's not as confusing as I first thought?

bsipocz commented 5 months ago

Ahh, I see where you're coming from. Maybe then docs_images? My only point that a flowchart, or logo or similar could end up in the same directory not just screenshots.

I clearly dealt with more docs and HTML repos than docker repos so have a bias and I'm not sure how standard it is, but at many places, I tend to see these types of images to be dumped under _static/images or something similar (So for me dumping docker images in a simple image directory feels extremely confusing).

troyraen commented 5 months ago

Thinking more... maybe static/images is the most future-proof?

bsipocz commented 5 months ago

Yes I think so. And I've browsed a little bit more: whether to start it with underscore or not I don't see a clear preference (~50/50 split), and at one places I saw it's being called assets/images, but that doesn't feel more clear that static/images. Anyway, I really am sorry about this bike shed.