feat: update markdown help page to match current editor features#4425
Open
SylvainChevalier wants to merge 4 commits intomainfrom
Open
feat: update markdown help page to match current editor features#4425SylvainChevalier wants to merge 4 commits intomainfrom
SylvainChevalier wants to merge 4 commits intomainfrom
Conversation
- Update intro to reference KaTeX instead of MathJax - Add new sections: Horizontal rules, Mentions, Embedded questions, Twitter embeds - Document image upload (max 3MB) via toolbar - Document code block language support (TypeScript, Python, Bash, etc.) - Document underline formatting from toolbar - Update embeds section with sub-sections for questions, tweets, and iframes - Remove outdated note about embeds only in question bodies - Mention rich-text and source editing modes - Update and improve Portuguese translation to match new content Closes #2292 Co-authored-by: Sylvain <SylvainChevalier@users.noreply.github.com>
SylvainChevalier
temporarily deployed
to
testing_env
GitHub Actions
Inactive
SylvainChevalier
temporarily deployed
to
testing_env
GitHub Actions
Inactive
Contributor
📝 WalkthroughWalkthroughUpdated English and Portuguese Markdown help pages: replaced MathJax with KaTeX/LaTeX references, added sections for Horizontal rules, Mentions, and Embeds, expanded editor/toolbar, code, images, and iframe/embed guidance, and added notes about rich-text vs source modes. No API or exported signatures changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
SylvainChevalier
temporarily deployed
to
Preview
GitHub Actions
Inactive
Contributor
🚀 Preview EnvironmentYour preview environment is ready!
Details
ℹ️ Preview Environment InfoIsolation:
Limitations:
Cleanup:
|
Contributor
Author
|
|
Claude finished @SylvainChevalier's task in 1m 18s —— View job Changes applied
Removed the Legacy MathJax syntax paragraphs from both |
Remove the Legacy MathJax syntax paragraphs from both English and Portuguese markdown help pages, as this feature is being removed. Co-authored-by: Sylvain <SylvainChevalier@users.noreply.github.com>
Contributor
Author
|
lgtm. |
SylvainChevalier
temporarily deployed
to
testing_env
GitHub Actions
Inactive
SylvainChevalier
temporarily deployed
to
testing_env
GitHub Actions
Inactive
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
front_end/src/app/(main)/help/markdown/page.tsx (1)
450-454:⚠️ Potential issue | 🟠 MajorAdd a descriptive
titleto the iframe embed example.The example iframe is missing
title, which creates an accessibility gap for screen-reader users.♿ Suggested fix
<iframe + title="Embedded Metaculus question example" src="https://www.metaculus.com/questions/embed/8/" height="320" width="550" ></iframe>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@front_end/src/app/`(main)/help/markdown/page.tsx around lines 450 - 454, The iframe embed is missing a descriptive title attribute which is required for accessibility; update the iframe element in page.tsx (the <iframe src="https://www.metaculus.com/questions/embed/8/"> instance) to include a concise, descriptive title such as "Metaculus question `#8` embed" (or similar text that clearly describes the embedded content) so screen readers can convey its purpose.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@front_end/src/app/`(main)/help/markdown/page_pt.tsx:
- Line 18: Update the insecure http links to use HTTPS: find the anchor elements
(e.g., the <a href="http://daringfireball.net/projects/markdown/">Markdown</a>{"
"} instance and the other similar <a href="http://daringfireball.net/...">
occurrences referenced) in page_pt.tsx and change their href values to start
with "https://", ensuring all Daring Fireball links (and any other http:// links
at the same locations) use "https://" instead.
- Around line 438-442: The iframe embed for
src="https://www.metaculus.com/questions/embed/8/" is missing a descriptive
title attribute; update the iframe element in page_pt.tsx to include a
meaningful title (e.g., "Metaculus question embed" or a Portuguese equivalent)
so assistive tech can describe the content, keeping the src, height, and width
attributes unchanged.
In `@front_end/src/app/`(main)/help/markdown/page.tsx:
- Line 26: Update the outbound documentation anchors in page.tsx to use HTTPS
instead of HTTP: replace href="http://daringfireball.net/projects/markdown/"
(and any other hrefs in the same file that start with "http://") with
"https://..." so all external Markdown/doc links (e.g., the anchor with link
text "Markdown" and the other occurrences flagged) use secure transport; ensure
you update every occurrence in the file (including the two additional instances
noted) so no external links remain on http.
---
Outside diff comments:
In `@front_end/src/app/`(main)/help/markdown/page.tsx:
- Around line 450-454: The iframe embed is missing a descriptive title attribute
which is required for accessibility; update the iframe element in page.tsx (the
<iframe src="https://www.metaculus.com/questions/embed/8/"> instance) to include
a concise, descriptive title such as "Metaculus question `#8` embed" (or similar
text that clearly describes the embedded content) so screen readers can convey
its purpose.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
front_end/src/app/(main)/help/markdown/page.tsxfront_end/src/app/(main)/help/markdown/page_pt.tsx
SylvainChevalier
temporarily deployed
to
Preview
GitHub Actions
Inactive
Contributor
Author
|
@claude address the failed tests and the review comments. |
|
Claude finished @SylvainChevalier's task in 3m 0s —— View job Addressing failed tests and review comments
All issues addressed in commit
|
- Switch http:// to https:// for Daring Fireball links in both pages - Add descriptive title attribute to iframe embeds for accessibility - Fix Prettier formatting Co-authored-by: Sylvain <SylvainChevalier@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@front_end/src/app/`(main)/help/markdown/page.tsx:
- Around line 441-446: The hostname is inconsistent: the trusted-sites list
shows "<li>metaculus.com</li>" while the iframe example uses
"www.metaculus.com"; standardize them by making the iframe example use the same
root host or explicitly list both. Update the iframe string from `<iframe
src="https://www.metaculus.com/questions/embed/8/" ...>` to use
`https://metaculus.com/questions/embed/8/` (or alternatively change the list
item to include both "metaculus.com" and "www.metaculus.com") so the
trusted-sites list and the iframe example match; look for the list item
"<li>metaculus.com</li>" and the template string containing `<iframe
src="https://www.metaculus.com/questions/embed/8/"` to apply the change.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
front_end/src/app/(main)/help/markdown/page.tsxfront_end/src/app/(main)/help/markdown/page_pt.tsx
Comment on lines
441
to
446
| <li>metaculus.com</li> | ||
| </ul> | ||
| <p>Note that this means you can embed Metaculus questions:</p> | ||
| <p>For example, you can embed a Metaculus question via iframe:</p> | ||
| <pre> | ||
| {`<iframe src="https://www.metaculus.com/questions/embed/8/" height="320" width="550"></iframe>`} | ||
| </pre> |
Contributor
There was a problem hiding this comment.
Align the Metaculus hostname between the trusted-sites list and iframe example.
Line 441 lists metaculus.com, while Line 445 uses www.metaculus.com. Please standardize this (or explicitly mention both) to avoid ambiguity about accepted iframe sources.
🛠️ Suggested docs-only fix
- <li>metaculus.com</li>
+ <li>metaculus.com (including www.metaculus.com)</li>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@front_end/src/app/`(main)/help/markdown/page.tsx around lines 441 - 446, The
hostname is inconsistent: the trusted-sites list shows "<li>metaculus.com</li>"
while the iframe example uses "www.metaculus.com"; standardize them by making
the iframe example use the same root host or explicitly list both. Update the
iframe string from `<iframe src="https://www.metaculus.com/questions/embed/8/"
...>` to use `https://metaculus.com/questions/embed/8/` (or alternatively change
the list item to include both "metaculus.com" and "www.metaculus.com") so the
trusted-sites list and the iframe example match; look for the list item
"<li>metaculus.com</li>" and the template string containing `<iframe
src="https://www.metaculus.com/questions/embed/8/"` to apply the change.
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.
Closes #2292
Summary
Generated with Claude Code
Summary by CodeRabbit