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

Typo Fixed #230

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Typo Fixed #230

wants to merge 1 commit into from

Conversation

snehaldalvi
Copy link

I have fixed a typo in readme file.

Copy link

@Imran-imtiaz48 Imran-imtiaz48 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review:

Overall Feedback:

The recent changes are well-documented and easy to follow. The explanations provided in the comments enhance the understanding of the terms and the reasons behind the naming conventions, which is very helpful for new developers.

Positives:

  1. Clarity in Instructions:

    • The steps for manual installation are clearly outlined. The links to the repository and specific files are direct and functional.
  2. Detailed Explanation:

    • The section on the origin of the term "shiv" is both informative and engaging. It provides a historical context which is often overlooked but appreciated.
  3. Formatting:

    • The use of Markdown for headers and emphasis is consistent and improves readability.

Areas for Improvement:

  1. Additional Examples:

    • Consider adding more examples of how to include the downloaded files in different types of projects (e.g., different frameworks or CMS).
  2. Error Handling:

    • Including a section on common errors and troubleshooting tips during the installation process would be beneficial.
  3. Updating Links:

    • Ensure all external links (e.g., to the blog and Wikipedia) are up-to-date and consider archiving them using a service like the Internet Archive to prevent link rot.
  4. Enhance Readability:

    • Breaking down long explanations into bullet points or shorter paragraphs can make it easier to read, especially for non-native English speakers.

Suggestions:

  • Code Snippets:
    Adding short code snippets showing how to include and utilize the html5shiv.js in a project would make the documentation more practical.

  • Visual Aids:
    Screenshots or diagrams showing the process of downloading, extracting, and including the files in a project could be helpful.


Overall, the documentation changes are well-executed and provide a solid foundation for users to understand and implement the html5shiv. With a few enhancements, it can become even more user-friendly and comprehensive.

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.

2 participants