Skip to content

Fix inline code rendering in setup docs#176

Merged
huzaifaalmesbah merged 2 commits into
WordPress:trunkfrom
ekamran:shifteq/fix-inline-code-rendering
Jun 8, 2026
Merged

Fix inline code rendering in setup docs#176
huzaifaalmesbah merged 2 commits into
WordPress:trunkfrom
ekamran:shifteq/fix-inline-code-rendering

Conversation

@ekamran

@ekamran ekamran commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes Markdown patterns that caused inline code and links to render awkwardly on setup pages.
  • Replaces fragile inline HTML spacing with normal Markdown spacing.
  • Cleans related wording on the affected setup, email testing, database inspection, and Playground pages.

Fixes #175

Testing

  • Ran git diff --check.
  • Checked for nested inline-code links.
  • Checked for unbalanced code fences.
  • Checked that no em dashes, smart quotes, CRLF characters, or <br> tags remain in the affected files.

@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: ekamran <ekamran@git.wordpress.org>
Co-authored-by: huzaifaalmesbah <huzaifaalmesbah@git.wordpress.org>
Co-authored-by: 3kori <r1k0@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@3kori

3kori commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator

Thank you for the PR @ekamran. However, it doesn't address the main issue in #175. For example, this paragraph in the Database Inspection page gets treated as a code block.

Screenshot 2026-06-07 225453

Since the syntax of that paragraph and the inline code looks correct and should be parsing accordingly. I opened #175 to hear from others what might be the root cause of the problem and how we can fix it.

Make another commit if you have a fix for the problem.

@ekamran

ekamran commented Jun 7, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for checking this.

I agree, the original Markdown syntax looks valid and GitHub renders it correctly. So this seems more like a Make Handbook rendering/sync issue than a normal Markdown issue.

I tried a possible workaround using HTML <code> tags for the affected inline code, but I am not fully sure that is the right fix because it only avoids the parser issue for this paragraph. It may not address the actual root cause.

So I think it is better to wait for input on #175 before adding another commit, unless the team prefers the workaround approach.

@3kori

3kori commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator

We try as much as possible to avoid using HTML tags within the MD files. I think the best approach would be to remove the inline code (`) characters entirely.

@3kori 3kori requested review from huzaifaalmesbah and ozgursar June 7, 2026 21:13
@ekamran

ekamran commented Jun 7, 2026

Copy link
Copy Markdown
Contributor Author

Thanks, I checked this a bit more.

The source Markdown looks valid and GitHub renders it correctly, but the live Make page output seems to be malformed.

For the Database Inspection page, the live HTML currently renders the paragraph like this:

Then open http://localhost:8080` in your browser. This uses the default local database credentials from the WordPress development environment. The default database name iswordpress_develop`.

The Markdown export also looks corrupted here:
https://make.wordpress.org/test/handbook/get-setup-for-testing/database-inspection/?output_format=md

So it looks like the issue is happening somewhere in the Make Handbook sync/rendering pipeline, not in GitHub Markdown itself.

For this PR, I can still make the requested workaround commit by removing the inline-code backticks from the affected Database Inspection paragraph. But I think the root cause may need a Meta ticket so other handbook pages with valid inline code do not keep hitting the same issue.

@huzaifaalmesbah

huzaifaalmesbah commented Jun 8, 2026

Copy link
Copy Markdown
Member

I noticed this issue only occurs with localhost URLs that include a port number when we use inline code formatting. As a simple fix, we can remove the backticks(`) and use normal text instead—there's no need for inline code formatting in this case.

Otherwise, we'll need to investigate further to understand how we can properly fix the issue. If necessary, we may need help from the Meta team. For now, though, I think the simplest approach is to remove the backticks from these pages:

Huzaifa-20260608222444

@huzaifaalmesbah huzaifaalmesbah left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@ekamran Thanks for your work on this PR. I noticed that several other changes have been included as well. Since this PR is mainly intended to fix #175, I think we should focus only on resolving the inline code formatting issue here.

If you've identified additional issues, could you please create separate issues and PRs for them? That will help keep this PR focused and make the review process easier.

@ekamran

ekamran commented Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review.

I pushed a follow-up commit and narrowed the PR scope. It now only removes inline-code formatting from the localhost URLs with port numbers on the four affected pages.

The PR diff should now be 4 files with one line changed in each file. I also reverted the extra cleanup changes so this stays focused on #175.

@3kori 3kori left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you for the fix.
LGTM, ready to merge.

@huzaifaalmesbah huzaifaalmesbah left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good to me

@huzaifaalmesbah huzaifaalmesbah merged commit ddfddf4 into WordPress:trunk Jun 8, 2026
3 checks passed
@ekamran ekamran deleted the shifteq/fix-inline-code-rendering branch June 8, 2026 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Inline Code formatting parsing breaks in some of the pages

3 participants