[wp-trac] [WordPress Trac] #63444: resolving readme rendering issue

[WordPress Trac]

#63444: resolving readme rendering issue
--------------------------+-----------------------------
 Reporter:  kerubindev    |      Owner:  (none)
     Type:  defect (bug)  |     Status:  assigned
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:  6.8
 Severity:  normal        |   Keywords:  needs-refresh
  Focuses:  ui, docs      |
--------------------------+-----------------------------
 README.html not rendering properly on GitHub - Add README.md
 Description
 The current README.html file in the WordPress repository is displayed as
 raw HTML code when viewed on GitHub instead of rendering properly. This
 affects readability and accessibility of the documentation for developers
 interacting with WordPress through GitHub.
 Steps to Reproduce

 Visit the WordPress repository on GitHub
 Observe that the README.html file is shown as raw HTML code rather than
 rendered content
 This issue is consistently present in Chrome, Firefox, and OperaGX
 browsers

 Environment

 WordPress Version: Latest (6.4.x)
 Browsers tested: Chrome, Firefox, OperaGX

 Expected Result
 The README file should be properly rendered and readable when viewing the
 repository on GitHub.
 Actual Result
 The README.html file is displayed as raw HTML code, making it difficult to
 read and navigate.
 Proposed Solution
 I've prepared a README.md file that contains the same content converted to
 Markdown format. GitHub automatically renders Markdown files, which would
 solve the issue while maintaining all the original content and structure.
 The original README.html can be kept for backward compatibility and for
 proper rendering when the file is accessed directly in a web browser.
 Additional Information

 This is purely a documentation improvement that doesn't affect WordPress
 functionality
 The conversion maintains all links, formatting, and content from the
 original file
 README.md files are standard practice for GitHub repositories and improve
 developer experience
 I can provide the converted README.md file as a patch if requested

 Thank you for considering this improvement.
 GitHub: https://github.com/KerubinDev

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/63444>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform