Make WordPress Core

Opened 6 months ago

Closed 6 months ago

#63444 closed defect (bug) (duplicate)

resolving readme rendering issue

Reported by: kerubindev's profile kerubindev Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch
Focuses: ui, docs Cc:

Description

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

Attachments (1)

README.MD (5.7 KB) - added by kerubindev 6 months ago.
Corrected Readme

Download all attachments as: .zip

Change History (3)

@kerubindev
6 months ago

Corrected Readme

This ticket was mentioned in PR #8802 on WordPress/wordpress-develop by @kerubindev.


6 months ago
#1

  • Keywords has-patch added; needs-refresh removed

Add README.md for proper GitHub rendering of WordPress repository

Add a Markdown version of the README to ensure proper rendering in the main WordPress GitHub repository (https://github.com/WordPress/WordPress).

The current README.html file in the main WordPress repository (https://github.com/WordPress/WordPress) displays as raw HTML code when viewed on GitHub, affecting readability and accessibility of WordPress documentation for developers. This PR adds a README.md file in Markdown format while maintaining the original README.html for backward compatibility.

Changes:

  • Convert HTML content to equivalent Markdown formatting
  • Preserve all links, structure, and information from the original
  • Maintain backward compatibility by keeping README.html

This improvement helps developers browsing the repository on GitHub to read the documentation more easily without having to download or view the raw HTML file.

Tested on Chrome, Firefox, and OperaGX browsers.

Props KerubinDev.
Fixes https://core.trac.wordpress.org/ticket/63444
README.MD

#2 @sabernhardt
6 months ago

  • Milestone Awaiting Review deleted
  • Resolution set to duplicate
  • Status changed from assigned to closed
  • Version 6.8 deleted

#37998 and #52315 are related, but #56086 is still open so I'll close as a duplicate of that.

Note: See TracTickets for help on using tickets.