BotFramework-WebChat icon indicating copy to clipboard operation
BotFramework-WebChat copied to clipboard

documentation fix: Fixes broken renderMarkdown link in HOOKS documentation

Open provSynevaRunyan opened this issue 2 years ago • 2 comments

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 avatar Dec 01 '23 06:12 provSynevaRunyan

Thank you. This is very helpful.

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

compulim avatar Dec 05 '23 00:12 compulim

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

compulim avatar Dec 05 '23 00:12 compulim