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

Use semantic coloring for code names in texts #32

Open
alexander-yevsyukov opened this issue Jun 27, 2023 · 2 comments
Open

Use semantic coloring for code names in texts #32

alexander-yevsyukov opened this issue Jun 27, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@alexander-yevsyukov
Copy link
Contributor

This issue is for discussion. I'm not 100% sure this is going to work for sure. The idea is to highlight code names in the text if they are events, commands, projections, or process managers. This way people would navigate the text a bit easier, and would learn the color code of EventStorming diagrams.

The style I have in mind is fixed size font, but with colored background and probably colored letters. It should look similarly to how Kotlin docs do this:

image

A command name in the text should probably look like this:

image

@alexander-yevsyukov alexander-yevsyukov added the documentation Improvements or additions to documentation label Jun 27, 2023
@alexander-yevsyukov
Copy link
Contributor Author

@armiol, what would you say to this suggestion?

@alexander-yevsyukov
Copy link
Contributor Author

alexander-yevsyukov commented Jun 27, 2023

Discussed the matter with @armiol vocally. Let's start with events, commands, and rejections first, and see how it looks. We'd like to avoid a salad-like view of the text.

We'd probably need to revisit the color schemas for our block code samples. For example, newer IDEA versions uses less vivid colors even in dart color theme:

image

Compare with what we have now at the site:

image

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

No branches or pull requests

1 participant