Fix: Update documentation #55
Conversation
|
✔️ Deploy preview for vaadin-docs-preview ready! 🔨 Explore the source changes: 5c6f4b3 🔍 Inspect the deploy logs: https://app.netlify.com/sites/vaadin-docs-preview/deploys/5fd36100d3427b00071fab89 😎 Browse the preview: https://deploy-preview-55--vaadin-docs-preview.netlify.app |
|
…kicking the preview build, let’s see if it works now 🤞 |
| [source, filesystem] | ||
| ---- | ||
| theme/ | contains all application themes | ||
| └── my-theme/ | contais files for 'my-theme' | ||
| ├── components | contains component specific themes | ||
| │ ├── vaadin-button.css | component themes need to match the tag name | ||
| │ └── vaadin-text-field.css | | ||
| ├── images | static resource folder | ||
| ├── webfonts | static resource folder | ||
| ├── document.css | css always applied to the root of the page | ||
| ├── global.css | contains theme changes, may be targeted | ||
| ├── my-theme.generated.js | auto-generated configuration file | ||
| └── theme.json | configuration for assets etc. | ||
| ---- |
There was a problem hiding this comment.
Actually, this doesn’t work that great, since the text wraps on new lines, and makes it hard to follow.
We could try using callouts instead: https://asciidoctor.org/docs/user-manual/#callouts
There was a problem hiding this comment.
Another option is to use a table, with minimal styling (remove outer frame and inner grid lines): https://docs-app-preview.netlify.app/styling-test/tables/
There was a problem hiding this comment.
Callouts seem better than table in this instance. Updated.
There was a problem hiding this comment.
Thanks. Just one problem: callouts are currently broken: https://github.com/vaadin/docs-app/issues/179
But we’ll get those fixed.
There was a problem hiding this comment.
I saw that too from the preview, but I guess it is fine for now.
Updated documentation to match the actual state of the project. Removed image and replaced it with a ascii map as the image is hard to update with all the constant changes. Fixes vaadin/flow#9595
Co-authored-by: Jouni Koivuviita <jouni@vaadin.com>
Fixed documentation part of #9627 Clean folder callouts
caalador
force-pushed
the
issues/9595
branch
from
3e0c5d8 to
5c6f4b3
Compare
Updated documentation to match the
actual state of the project.
Removed image and replaced it with a ascii map
as the image is hard to update with all the constant
changes.
Fixes vaadin/flow#9595
Addresses documentation part of vaadin/flow#9627