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

docs(zh): for pkg json #312

Merged
merged 1 commit into from
Sep 18, 2024
Merged

docs(zh): for pkg json #312

merged 1 commit into from
Sep 18, 2024

Conversation

lijunchen
Copy link
Contributor

No description provided.

Copy link

peter-jerry-ye-code-review bot commented Sep 18, 2024

From the provided git diff output, I observe several potential issues and areas for improvement in the documentation:

  1. Typo in File Path:

    • In the file path docs/manual-zh/src/package/alerts.md, the word "alerts" is likely a typo and should be "alert" to match the context of the section discussing the alert_list configuration.
  2. Inconsistent JSON Example:

    • In docs/manual-zh/src/package/conditional-compilation.md, the JSON example for targets configuration uses double quotes for string values, which is correct. However, the JSON examples in other files like docs/manual-zh/src/package/alerts.md use single quotes, which is not valid JSON syntax. Ensure all JSON examples consistently use double quotes.
  3. Missing Context in Examples:

    • In docs/manual-zh/src/package/pre-build.md, the example command :embed -i ${input} -o ${output} uses ${input} and ${output}, which might be confusing if the reader is not familiar with command substitution. It would be helpful to clarify that these are placeholders replaced with the actual input and output files specified in the JSON configuration.

These observations focus on improving the clarity and correctness of the documentation, ensuring that readers can follow the examples and configurations accurately.

@lijunchen lijunchen marked this pull request as ready for review September 18, 2024 08:14
@lijunchen lijunchen merged commit 8cc78e0 into main Sep 18, 2024
9 checks passed
@lijunchen lijunchen deleted the zh-docs-for-pkg-json branch September 18, 2024 08:14
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.

1 participant