Closed
Conversation
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
13 issues found across 48 files
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="docs/assets/fonts.mdx">
<violation number="1" location="docs/assets/fonts.mdx:32">
P3: The example contradicts the stated requirement that `as_file` must be `true` for file-based fonts and uses `src` instead of the documented `src_path`. This will mislead readers into using the wrong configuration.</violation>
</file>
<file name="docs/tools/cli.mdx">
<violation number="1" location="docs/tools/cli.mdx:9">
P3: This warning states the pre-release build “Expires end of 2025,” which is already in the past as of 2026-01-19. This makes the documentation misleading and likely incorrect; either update the expiry or remove the date so the doc stays accurate.</violation>
</file>
<file name="docs/ui-elements/api.mdx">
<violation number="1" location="docs/ui-elements/api.mdx:322">
P3: The example uses `icon_src` instead of the documented `icon` property name, which makes the property usage inconsistent with the API definition.</violation>
<violation number="2" location="docs/ui-elements/api.mdx:349">
P3: The example uses `color` instead of the documented `new_color` argument, which makes the usage inconsistent with the API definition.</violation>
</file>
<file name="docs/xml-overview/overview.mdx">
<violation number="1" location="docs/xml-overview/overview.mdx:33">
P2: The Editor link points to `./editor/overview`, which resolves to a non-existent path relative to `docs/xml-overview/overview.mdx`. It should link to the sibling `docs/editor/overview.mdx` via `../editor/overview`.</violation>
</file>
<file name="docs/xml-overview/xml-license.mdx">
<violation number="1" location="docs/xml-overview/xml-license.mdx:44">
P3: Replace "into" with "in" for correct grammar in the restriction list.</violation>
</file>
<file name="docs/features/ui-testing.mdx">
<violation number="1" location="docs/features/ui-testing.mdx:46">
P2: The XML example is invalid because the `steps` block is missing the opening `<steps>` tag. Readers copying this snippet will get a parsing error. Use `<steps>` instead of the bare `steps` line.</violation>
</file>
<file name="docs/assets/images.mdx">
<violation number="1" location="docs/assets/images.mdx:42">
P3: The C example omits the required semicolon, which makes the snippet invalid C. Add the semicolon so readers can copy/paste a compilable line.</violation>
</file>
<file name="docs/xml-overview/syntax.mdx">
<violation number="1" location="docs/xml-overview/syntax.mdx:11">
P3: The tag name rule omits `-`, but the next bullet says compound names use `-` (e.g., `lv_chart-series`). This is inconsistent and can confuse readers about whether hyphens are allowed. Update the rule to include `-` as a valid character.</violation>
</file>
<file name="docs/tools/figma-integration.mdx">
<violation number="1" location="docs/tools/figma-integration.mdx:44">
P2: The XML example is missing opening tags for `component`, `styles`, and `view`, so the snippet is invalid XML. This will break copy/paste usage in the Editor docs.</violation>
<violation number="2" location="docs/tools/figma-integration.mdx:74">
P3: The `project_local.xml` example is missing the opening `<project_local>` tag, which makes the snippet invalid XML.</violation>
</file>
<file name="docs/ui-elements/widgets.mdx">
<violation number="1" location="docs/ui-elements/widgets.mdx:127">
P3: The XML example uses `wrap="scroll"`, but the parser example only handles the `long_mode` attribute. This inconsistency will mislead readers about which attribute to use. Align the XML example with the documented parser attribute name.</violation>
</file>
<file name="docs/integration/arduino-ide.mdx">
<violation number="1" location="docs/integration/arduino-ide.mdx:80">
P2: The platform.txt example escapes the variable placeholders with backslashes, which would be copied verbatim and stop Arduino from expanding {runtime.os}, {build.fqbn}, etc. Remove the backslashes so the placeholders expand correctly.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
|
|
||
| The Editor provides live preview, inspector tools, code generation, auto-completion, syntax highlighting, validation, online preview and sharing for team feedback, and Figma integration to convert designs directly to XML. | ||
|
|
||
| [Learn more about the Editor](./editor/overview) |
There was a problem hiding this comment.
P2: The Editor link points to ./editor/overview, which resolves to a non-existent path relative to docs/xml-overview/overview.mdx. It should link to the sibling docs/editor/overview.mdx via ../editor/overview.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/xml-overview/overview.mdx, line 33:
<comment>The Editor link points to `./editor/overview`, which resolves to a non-existent path relative to `docs/xml-overview/overview.mdx`. It should link to the sibling `docs/editor/overview.mdx` via `../editor/overview`.</comment>
<file context>
@@ -0,0 +1,115 @@
+
+The Editor provides live preview, inspector tools, code generation, auto-completion, syntax highlighting, validation, online preview and sharing for team feedback, and Figma integration to convert designs directly to XML.
+
+[Learn more about the Editor](./editor/overview)
+</Callout>
+
</file context>
| <lv_slider /> | ||
| </view> | ||
|
|
||
| steps |
There was a problem hiding this comment.
P2: The XML example is invalid because the steps block is missing the opening <steps> tag. Readers copying this snippet will get a parsing error. Use <steps> instead of the bare steps line.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/features/ui-testing.mdx, line 46:
<comment>The XML example is invalid because the `steps` block is missing the opening `<steps>` tag. Readers copying this snippet will get a parsing error. Use `<steps>` instead of the bare `steps` line.</comment>
<file context>
@@ -0,0 +1,138 @@
+ <lv_slider />
+ </view>
+
+ steps
+ <screenshot_compare path="imgs/before.png"/>
+ <click_at x="32" y="32"/>
</file context>
| XML style section. For example: | ||
|
|
||
| ``` xml | ||
| component |
There was a problem hiding this comment.
P2: The XML example is missing opening tags for component, styles, and view, so the snippet is invalid XML. This will break copy/paste usage in the Editor docs.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/tools/figma-integration.mdx, line 44:
<comment>The XML example is missing opening tags for `component`, `styles`, and `view`, so the snippet is invalid XML. This will break copy/paste usage in the Editor docs.</comment>
<file context>
@@ -0,0 +1,98 @@
+XML style section. For example:
+
+``` xml
+component
+ styles
+ <style name="style_from_figma"
</file context>
| **Step 4: Example Modified Line** | ||
|
|
||
| ```text | ||
| build.extra_flags=-DARDUINO_HOST_OS="\{runtime.os\}" -DARDUINO_FQBN="\{build.fqbn\}" -DESP32=ESP32 -DCORE_DEBUG_LEVEL=\{build.code_debug\} \{build.loop_core\} \{build.event_core\} \{build.defines\} \{build.extra_flags.\{build.mcu\}\} \{build.zigbee_mode\} -DLV_LVGL_H_INCLUDE_SIMPLE |
There was a problem hiding this comment.
P2: The platform.txt example escapes the variable placeholders with backslashes, which would be copied verbatim and stop Arduino from expanding {runtime.os}, {build.fqbn}, etc. Remove the backslashes so the placeholders expand correctly.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/integration/arduino-ide.mdx, line 80:
<comment>The platform.txt example escapes the variable placeholders with backslashes, which would be copied verbatim and stop Arduino from expanding {runtime.os}, {build.fqbn}, etc. Remove the backslashes so the placeholders expand correctly.</comment>
<file context>
@@ -0,0 +1,190 @@
+**Step 4: Example Modified Line**
+
+```text
+build.extra_flags=-DARDUINO_HOST_OS="\{runtime.os\}" -DARDUINO_FQBN="\{build.fqbn\}" -DESP32=ESP32 -DCORE_DEBUG_LEVEL=\{build.code_debug\} \{build.loop_core\} \{build.event_core\} \{build.defines\} \{build.extra_flags.\{build.mcu\}\} \{build.zigbee_mode\} -DLV_LVGL_H_INCLUDE_SIMPLE
+```
+
</file context>
| ```xml | ||
| globals | ||
| fonts | ||
| <bin as_file="false" name="medium" src="path/to/file.ttf" range="0x20-0x7f" symbols="°" size="24"/> |
There was a problem hiding this comment.
P3: The example contradicts the stated requirement that as_file must be true for file-based fonts and uses src instead of the documented src_path. This will mislead readers into using the wrong configuration.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/assets/fonts.mdx, line 32:
<comment>The example contradicts the stated requirement that `as_file` must be `true` for file-based fonts and uses `src` instead of the documented `src_path`. This will mislead readers into using the wrong configuration.</comment>
<file context>
@@ -0,0 +1,154 @@
+```xml
+globals
+ fonts
+ <bin as_file="false" name="medium" src="path/to/file.ttf" range="0x20-0x7f" symbols="°" size="24"/>
+ <tiny_ttf as_file="true" name="big" src_path="path/to/file.ttf" range="0x20-0x7f" size="48"/>
+ </fonts>
</file context>
| - Implement or extend this Specification in any **software or platform that provides UI creation, editing, or design capabilities similar to those in the LVGL UI Editor**. | ||
| - Build public APIs, plugins, converters, or SDKs based on this Specification. | ||
| - Share or publish internal tooling built around this Specification. | ||
| - Use this Specification into general-purpose design tools or frameworks outside the LVGL ecosystem. |
There was a problem hiding this comment.
P3: Replace "into" with "in" for correct grammar in the restriction list.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/xml-overview/xml-license.mdx, line 44:
<comment>Replace "into" with "in" for correct grammar in the restriction list.</comment>
<file context>
@@ -0,0 +1,76 @@
+- Implement or extend this Specification in any **software or platform that provides UI creation, editing, or design capabilities similar to those in the LVGL UI Editor**.
+- Build public APIs, plugins, converters, or SDKs based on this Specification.
+- Share or publish internal tooling built around this Specification.
+- Use this Specification into general-purpose design tools or frameworks outside the LVGL ecosystem.
+
+These restrictions apply regardless of whether the software is commercial, free, or open-source.
</file context>
| they need to be registered explicitly using: | ||
|
|
||
| ```cpp | ||
| lv_xml_register_image(NULL, "image_name", &my_image) |
There was a problem hiding this comment.
P3: The C example omits the required semicolon, which makes the snippet invalid C. Add the semicolon so readers can copy/paste a compilable line.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/assets/images.mdx, line 42:
<comment>The C example omits the required semicolon, which makes the snippet invalid C. Add the semicolon so readers can copy/paste a compilable line.</comment>
<file context>
@@ -0,0 +1,72 @@
+they need to be registered explicitly using:
+
+```cpp
+lv_xml_register_image(NULL, "image_name", &my_image)
+```
+
</file context>
| ## Naming Conventions | ||
|
|
||
| - **Attribute names** use lowercase letters with `_` separation (e.g., `bg_color`, `font_size`) | ||
| - **Tag names** must start with a letter or `_` and can contain letters, `_`, and digits |
There was a problem hiding this comment.
P3: The tag name rule omits -, but the next bullet says compound names use - (e.g., lv_chart-series). This is inconsistent and can confuse readers about whether hyphens are allowed. Update the rule to include - as a valid character.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/xml-overview/syntax.mdx, line 11:
<comment>The tag name rule omits `-`, but the next bullet says compound names use `-` (e.g., `lv_chart-series`). This is inconsistent and can confuse readers about whether hyphens are allowed. Update the rule to include `-` as a valid character.</comment>
<file context>
@@ -0,0 +1,134 @@
+## Naming Conventions
+
+- **Attribute names** use lowercase letters with `_` separation (e.g., `bg_color`, `font_size`)
+- **Tag names** must start with a letter or `_` and can contain letters, `_`, and digits
+- **Compound names** use `-` as separator (e.g., `lv_chart-series`)
+- **Color values** support multiple formats like CSS:
</file context>
| following content: | ||
|
|
||
| ``` xml | ||
| project_local |
There was a problem hiding this comment.
P3: The project_local.xml example is missing the opening <project_local> tag, which makes the snippet invalid XML.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/tools/figma-integration.mdx, line 74:
<comment>The `project_local.xml` example is missing the opening `<project_local>` tag, which makes the snippet invalid XML.</comment>
<file context>
@@ -0,0 +1,98 @@
+following content:
+
+``` xml
+project_local
+ <figma document="XXXXXX" token="YYYYY"/>
+</project_local>
</file context>
|
|
||
| ```xml | ||
| <view> | ||
| <lv_label width="100" text="I'm a label!" wrap="scroll"/> |
There was a problem hiding this comment.
P3: The XML example uses wrap="scroll", but the parser example only handles the long_mode attribute. This inconsistency will mislead readers about which attribute to use. Align the XML example with the documented parser attribute name.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/ui-elements/widgets.mdx, line 127:
<comment>The XML example uses `wrap="scroll"`, but the parser example only handles the `long_mode` attribute. This inconsistency will mislead readers about which attribute to use. Align the XML example with the documented parser attribute name.</comment>
<file context>
@@ -0,0 +1,171 @@
+
+```xml
+<view>
+ <lv_label width="100" text="I'm a label!" wrap="scroll"/>
+</view>
+```
</file context>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR moves the LVGL Pro documentation to this repository, including editor guides, UI elements, XML overview, integration examples, assets, and tools documentation.
Summary by cubic
Adds the full LVGL Pro documentation to this repository, covering the Editor, XML format, UI elements, integrations, assets, features, and tools. This centralizes Pro docs so they can be built and hosted from this codebase.
New Features
Migration
Written for commit f74b377. Summary will update on new commits.