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

Tweak readme and docs #314

Merged
merged 2 commits into from
Sep 18, 2024
Merged

Tweak readme and docs #314

merged 2 commits into from
Sep 18, 2024

Conversation

lijunchen
Copy link
Contributor

Related Issues

  • Related issues: #____

Type of Pull Request

  • Bug fix
  • New feature
    • I have already discussed this feature with the maintainers.
  • Refactor
  • Performance optimization
  • Documentation
  • Other (please describe):

Copy link

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

Summary of Discovered Problems

  1. Duplicate Content in Documentation:

    • The moon help output is duplicated in both the English (docs/manual/src/tutorial.md) and Chinese (docs/manual-zh/src/tutorial.md) tutorial files. This duplication can lead to maintenance issues if the command output changes in the future.
  2. Redundant Command Documentation:

    • The detailed command list and options from the moon help output are currently included in the README.md file. This can be simplified to avoid redundancy and potential inconsistencies.
  3. Incomplete Quickstart Example:

    • The quickstart example in the README.md file instructs users to run moon run src/main without ensuring that src/main exists or providing an example of what src/main might contain. This could confuse new users who are following the quickstart guide.

Suggestions

  1. Remove Duplication:

    • Consider removing the detailed moon help output from the tutorial files (docs/manual/src/tutorial.md and docs/manual-zh/src/tutorial.md). Instead, refer users to the moon help command for the most up-to-date information.
  2. Simplify README:

    • Simplify the README.md file by removing the detailed command list and options. A brief overview or a link to a dedicated documentation page for the moon command would be more maintainable.
  3. Improve Quickstart Example:

    • Enhance the quickstart example by ensuring it includes all necessary steps for a new user to successfully run a MoonBit program. For instance, provide an example of a simple src/main file or clarify that the user needs to create this file with a basic MoonBit program.

By addressing these issues, the documentation will become more concise, easier to maintain, and less confusing for new users.

@lijunchen lijunchen marked this pull request as ready for review September 18, 2024 08:56
@lijunchen lijunchen force-pushed the tweak-readme-and-docs branch from d14c2ff to 53c9212 Compare September 18, 2024 08:57
@lijunchen lijunchen enabled auto-merge September 18, 2024 08:58
@lijunchen lijunchen merged commit b04a40d into main Sep 18, 2024
9 checks passed
@lijunchen lijunchen deleted the tweak-readme-and-docs branch September 18, 2024 09:02
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