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

Change docs image #911

Merged
merged 2 commits into from
Jun 26, 2024
Merged

Change docs image #911

merged 2 commits into from
Jun 26, 2024

Conversation

rafmudaf
Copy link
Collaborator

@rafmudaf rafmudaf commented May 27, 2024

Change the documentation icon

The icon currently in the docs site was created quickly and without much group consensus a few years ago. At that time, I felt that it was important to have some very easily identifiable indication of what the software does in the position where a logo would go, so I created something intentionally on the nose. However, this was not intended to be a long term decision, and I think that current image has overstayed its welcome. Primarily, it's not possible to embed it in many types of messaging, and it is too complex.

@misi9170 recently shared an image that I think could be ultimately adopted as the next iteration of the FLORIS docs icon. The one he shared was square, and I cropped it to have a 2:3 height-to-width ratio. This pull request includes the change to the docs site to use this image.

Ultimately, I think we should discuss a long term logo and general branding. There are some issues with even this image if it were to be used as a logo:

  • It doesn't say "floris"
  • The colors are not generally accessible
  • A black and white version may not have much contrast depending on the calculation of brightness per color channel

However, I think it's a step in the right direction, and I suggest to adopt it temporarily.

Related issue

None

Impacted areas of the software

Docs site and other associated branding for FLORIS

Additional supporting information

Nice one @misi9170!

@rafmudaf
Copy link
Collaborator Author

Also, I used it here and I think it looks nice.

@christiannvaughn
Copy link
Collaborator

We need to run this by our WETO TM and Comms before making it official.

@rafmudaf rafmudaf changed the title Change docs logo Change docs image May 28, 2024
@rafmudaf
Copy link
Collaborator Author

We need to run this by our WETO TM and Comms before making it official.

Did I say logo? I meant docs site image.

@christiannvaughn
Copy link
Collaborator

Well the official logo is on our to-do list. I will add it to the agenda for our next meeting. Maybe we can provide some FLORIS 4.0 release stats in that meeting too.

@misi9170 misi9170 merged commit 084e931 into NREL:develop Jun 26, 2024
8 checks passed
@misi9170 misi9170 mentioned this pull request Jul 15, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants