fix(docs): replace invalid </br> tags and format swallowed placeholder URL#27174
Draft
nickvigilante wants to merge 1 commit into
Draft
Conversation
…r URL </br> is not a real HTML tag (br is a void element with no closing form); browsers error-correct it but it is invalid HTML. Replace all 15 usages with <br />. In github-to-tasks.md, https://<your-coder-url>/... was unformatted, so HTML renderers parse <your-coder-url> as an unknown tag and drop it; the live docs show a broken "https:///settings/external-auth". Wrap it in backticks like every other instance in the file. DOCS-550
Docs preview📖 View docs preview for |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes two classes of invalid/broken HTML in hand-written docs. Both are visible problems in today's rendered docs, independent of any docs-engine work.
</br>is not a real HTML tag.bris a void element with no closing form; browsers error-correct</br>, but it is invalid HTML. Replaced all 15 usages with<br />across:docs/admin/templates/extending-templates/dynamic-parameters.mddocs/admin/users/idp-sync.mddocs/tutorials/best-practices/organizations.mddocs/ai-coder/github-to-tasks.md,https://<your-coder-url>/settings/external-authwas unformatted, so HTML renderers parse<your-coder-url>as an unknown tag and drop it. The live docs currently render the broken textre-authenticate at https:///settings/external-auth. Wrapped in backticks, matching every other instance in the same file.Table realignment noise in the diff is from
fmt/markdown(<br />is one character wider than</br>).A repo-wide grep confirms no remaining
</br>and no other unformattedhttps://<placeholder>URLs in prose (other hits are inside code fences or already backticked). The equivalent placeholder issues in generated reference docs (CLI help strings, swagger annotations) are intentionally out of scope and tracked separately in DOCS-551.Tracking issue: DOCS-550
Created by Coder Agents on behalf of @nickvigilante.