Mayil-AI-Sandbox / klaw-june23

Apache License 2.0
0 stars 0 forks source link

Docs: Broken link in markdown (hashtag2526) #2

Open NobleMathews opened 3 months ago

NobleMathews commented 3 months ago

hashtag What happened? ![image](

hashtag What did you expect to happen? There's a whitespace which breaks the link.

hashtag What else do we need to know? I was setting this up with a remote api when I noticed this. This is an extremely trivial issue lol.

)

mayil-ai[bot] commented 3 months ago

To address the broken link issue in the coral/docs/documentation.md file, follow these actionable steps:

Steps:

  1. Open coral/docs/documentation.md.
  2. Locate the broken link, which might look like ![image]( or similar.
  3. Correct the link syntax to ensure there are no extra spaces or missing characters.

Example Fix:

Before:
![image]( https://example.com/image.png)

After:
![image](https://example.com/image.png)
  1. Save the file and verify the fix by running the documentation through the markdown to HTML transformation process defined in coral/src/domain/helper/documentation-helper.ts.
// Example of how to use the helper to verify the fix
import { createStringifiedHtml } from './coral/src/domain/helper/documentation-helper';

const markdownContent = `![image](https://example.com/image.png)`;
createStringifiedHtml(markdownContent).then((htmlContent) => {
  console.log(htmlContent); // Verify the HTML output
});

Here are some code snippets that may help you get started:

💡 To rerun Mayil, comment mayil-ai rerun. Mayil will incorporate any new context added to the ticket. Include details in your rerun comment to guide Mayil!