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

Page Loading Blank on Inline Documentation Link #1813

Open
Rima1889 opened this issue Jan 6, 2025 · 3 comments
Open

Page Loading Blank on Inline Documentation Link #1813

Rima1889 opened this issue Jan 6, 2025 · 3 comments
Assignees
Labels
[Status] Review Issue in review user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@Rima1889
Copy link

Rima1889 commented Jan 6, 2025

Issue Description

When a user tries to access the page at the provided link, the page loads blank. This creates confusion for users attempting to find documentation or inline reference for WordPress Core.

URL of the Page with the Issue

https://make.wordpress.org/core/handbook/docs/inline/

Why is this a problem?

https://tinyurl.com/27k4fegx

Copy link

github-actions bot commented Jan 6, 2025

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@karthick-murugan karthick-murugan self-assigned this Feb 6, 2025
@karthick-murugan
Copy link
Collaborator

Inline documentation

Inline documentation refers to concise comments added directly within the code to explain its functionality, usage, and purpose. In WordPress, inline docs help developers understand how functions, classes, hooks, and parameters work by providing clear, structured explanations. These comments follow standardized formats such as PHPDoc for PHP files and JSDoc for JavaScript files. Well-written inline documentation improves code readability, makes maintenance easier, and enhances collaboration within the developer community. Contributing to inline docs ensures that WordPress remains well-documented and accessible to both new and experienced developers.

@karthick-murugan karthick-murugan added user documentation (HelpHub) Improvements or additions to end-user documentation [Status] Review Issue in review labels Feb 6, 2025
Copy link

github-actions bot commented Feb 6, 2025

Heads up @docs-reviewers - the "[Status] Review" label was applied to this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] Review Issue in review user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
None yet
Development

No branches or pull requests

2 participants