Skip to content

API Docs: Update AI tutorial to include markdown block - #2486

Merged
haleychaas merged 4 commits into
mainfrom
update-tutorial-markdown-block
Apr 4, 2025
Merged

haleychaas merged 4 commits into
mainfrom
update-tutorial-markdown-block

Conversation

@haleychaas

Copy link
Copy Markdown
Contributor

Summary

Now that we have the markdown block available to help with markdown translations, we should have it in the tutorial as an option.

Requirements (place an x in each [ ])

@codecov

codecov Bot commented Mar 31, 2025 •

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests βœ…

Project coverage is 92.59%. Comparing base (9410015) to head (2d0b797).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2486   +/-   ##
=======================================
  Coverage   92.59%   92.59%           
=======================================
  Files          36       36           
  Lines        7472     7472           
  Branches      653      653           
=======================================
  Hits         6919     6919           
  Misses        545      545           
  Partials        8        8           

β˜” View full report in Codecov by Sentry.
πŸ“’ Have feedback on the report? Share it here.

πŸš€ New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • πŸ“¦ JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread docs/content/tutorials/ai-assistant.md Outdated

#### Using the markdown block in `say` {#markdown-block}

To safeguard against any markdown translation errors, we can return our text response inside of a [`Markdown block`](https://docs.slack.dev/reference/block-kit/blocks/markdown-block) in the `say` block, instead of relying on providing precise enough instructions to the LLM. Here's how that would look:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
To safeguard against any markdown translation errors, we can return our text response inside of a [`Markdown block`](https://docs.slack.dev/reference/block-kit/blocks/markdown-block) in the `say` block, instead of relying on providing precise enough instructions to the LLM. Here's how that would look:
To safeguard against any markdown translation errors, we can return our text response inside of a [markdown block](https://docs.slack.dev/reference/block-kit/blocks/markdown-block) in the `say` block, instead of relying on providing precise enough instructions to the LLM. Here's how that would look:

i don't think we put them in code blocks?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i'd also use a different word than "block" for "say block"

@haleychaas
haleychaas merged commit de020cc into main Apr 4, 2025
@haleychaas
haleychaas deleted the update-tutorial-markdown-block branch April 4, 2025 14:59
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