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

Better colors for "info" and "success" notes in the documentation and website #1893

Merged
merged 1 commit into from
Oct 6, 2022

Conversation

mosra
Copy link
Collaborator

@mosra mosra commented Oct 6, 2022

Motivation and Context

Sorry for opening too many PRs lately :D I was in the process of writing high-level docs for the batch renderer in #1874, submitted #1889 for doc updates already, but then wanted to put some note blocks into the doc copy, realized they look kinda awful, and had to fix those too. Before:

After:

The "warning" note was good enough already, but apparently those two were never used so far so they still had the dark theme colors. I didn't spend time updating the remaining color styles for "primary" and "danger" as I don't need them at the moment, and this was enough of a detour already 😅 Same for #1812, originally I wanted to merge those changes with mine, but the font and spacing changes felt like a lot more time investment would be needed to get things look consistent again, so I didn't either. The two PRs don't conflict with each other, at least.

Also updated the m.css submodule to latest, because why not, and added a note into the documentation README about updating CSS colors. Reverting a change from #1889 that added a few new Doxygen aliases, as those were present in Doxyfile-mcss already; added a new alias for relative references that look shorter in the output, and added a predefined DOXYGEN_GENERATING_OUTPUT macro for hiding internal and nasty-looking code from Doxygen.

Once merged, I'll transfer the CSS changes to the lab and website repos.

How Has This Been Tested

See screenshots above.

The warning note was good enough already, but apparently those two were
never used so far so they still had the dark theme colors.

Also updated the m.css submodule to latest, because why not.
@mosra mosra requested a review from aclegg3 October 6, 2022 17:42
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Oct 6, 2022
Copy link
Contributor

@0mdc 0mdc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@mosra mosra merged commit 6ad4020 into main Oct 6, 2022
@mosra mosra deleted the css-better-note-colors branch October 6, 2022 19:44
aclegg3 pushed a commit that referenced this pull request Oct 6, 2022
The warning note was good enough already, but apparently those two were
never used so far so they still had the dark theme colors.

Also updated m.css to latest, and some other Doxyfile additions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants