Skip to content

documentation fix: Fixes broken renderMarkdown link in HOOKS documentation#4971

Merged
OEvgeny merged 6 commits intomicrosoft:mainfrom
provSynevaRunyan:fix/update-link-for-referencing-customizations-of-renderMarkdown
Aug 15, 2025
Merged

documentation fix: Fixes broken renderMarkdown link in HOOKS documentation#4971
OEvgeny merged 6 commits intomicrosoft:mainfrom
provSynevaRunyan:fix/update-link-for-referencing-customizations-of-renderMarkdown

Conversation

@provSynevaRunyan
Copy link
Copy Markdown
Contributor

@provSynevaRunyan provSynevaRunyan commented Dec 1, 2023

When reading the documentation for the useRenderMarkdownAsHTML hook, I noticed a broken link;

The PR updates the renderMarkdown description and link to point to the renderMarkdown.ts file.

Changelog Entry

Change does not affect product, just documentation. Happy to add if needed, but didn't think it was

Description

Before:

  • Go to docs/HOOKS.md
  • Navigate to useRenderMarkdownAsHTML section
  • Click on bundle/src/renderMarkdown.js
  • Link gives a 404

After:

  • Go to docs/HOOKS.md
  • Navigate to useRenderMarkdownAsHTML section
  • Click on `bundle/src/markdown/renderMarkdown.ts
  • Navigated to renderMarkdown file.

Design

n/a

Specific Changes

  • Fixes broken renderMarkdown link in HOOKS documentation
  • I have added tests and executed them locally - n/a
  • I have updated CHANGELOG.md - n/a
  • I have updated documentation - n/a

Review Checklist

This section is for contributors to review your work.

  • Accessibility reviewed (tab order, content readability, alt text, color contrast)
  • Browser and platform compatibilities reviewed
  • CSS styles reviewed (minimal rules, no z-index)
  • Documents reviewed (docs, samples, live demo)
  • Internationalization reviewed (strings, unit formatting)
  • package.json and package-lock.json reviewed
  • Security reviewed (no data URIs, check for nonce leak)
  • Tests reviewed (coverage, legitimacy)

@provSynevaRunyan provSynevaRunyan changed the title document typo: Fixed broken renderMarkdown link in HOOKS documentation documentation fix: Fixed broken renderMarkdown link in HOOKS documentation Dec 1, 2023
@provSynevaRunyan provSynevaRunyan changed the title documentation fix: Fixed broken renderMarkdown link in HOOKS documentation documentation fix: Fixes broken renderMarkdown link in HOOKS documentation Dec 1, 2023
@compulim
Copy link
Copy Markdown
Contributor

compulim commented Dec 5, 2023

Thank you. This is very helpful.

Our team is full of stuff right now. Tiny changes helps us better than huge ones. 🤣

@compulim compulim added this to the imminent milestone Dec 5, 2023
@compulim
Copy link
Copy Markdown
Contributor

compulim commented Dec 5, 2023

Note to myself: ready to merge, need to fix CI.

@OEvgeny OEvgeny enabled auto-merge (squash) August 15, 2025 04:19
@OEvgeny OEvgeny merged commit b72725d into microsoft:main Aug 15, 2025
25 checks passed
@provSynevaRunyan provSynevaRunyan deleted the fix/update-link-for-referencing-customizations-of-renderMarkdown branch August 15, 2025 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants