Skip to content

Updated mathematical formula support for content blocks #631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2025

Conversation

validbeck
Copy link
Collaborator

@validbeck validbeck commented Jan 22, 2025

Internal Notes for Reviewers

sc-8183

Work with content blocks

Updated this page to accommodate for the new LaTeX formula editor:

Screenshot 2025-01-22 at 1 26 33 PM

@validbeck validbeck added the internal Not to be externalized in the release notes label Jan 22, 2025
@validbeck validbeck self-assigned this Jan 22, 2025
@validbeck validbeck requested a review from nrichers January 22, 2025 21:27
@validbeck validbeck changed the title Beck/sc 8183/documentation add ckeditor5 math support Updated mathematical formula support for content blocks Jan 22, 2025
@validbeck validbeck requested a review from panchicore January 22, 2025 21:27
@validbeck validbeck assigned cachafla and unassigned cachafla Jan 22, 2025
@validbeck validbeck requested a review from cachafla January 22, 2025 21:27
Copy link
Contributor

PR Summary

This pull request introduces enhancements to the documentation by improving the formatting and instructions related to contributing and working with mathematical formulas.

  1. README.md Enhancements:

    • Added important and tip callouts to emphasize the importance of reading the ValidMind style guide and to guide users on authoring new code samples.
  2. Mathematical Formula Instructions:

    • Updated the instructions for inserting mathematical formulas in content blocks.
    • Changed the toolbar icon description from to $f(x)$ for clarity.
    • Provided detailed steps for using the formula editor, including toggling display modes for inline or block equations.
    • Added visual aids with screenshots to illustrate the equation preview and display modes.

These changes aim to improve the clarity and usability of the documentation, making it easier for contributors to follow guidelines and for users to work with mathematical content.

Test Suggestions

  • Verify that the new callout formatting in README.md renders correctly in the documentation.
  • Check that the updated instructions for inserting mathematical formulas are clear and accurate.
  • Ensure that the screenshots are correctly linked and display as expected in the documentation.
  • Test the functionality of the formula editor to confirm that the described steps produce the expected results.

@validbeck
Copy link
Collaborator Author

@panchicore @cachafla Can one of you review the mathematical formuals section and approve if it looks good? 🙏🏻

Screenshot 2025-01-22 at 1 26 33 PM

Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

Great 👏

@validbeck validbeck merged commit f315a49 into main Jan 22, 2025
9 checks passed
@validbeck validbeck deleted the beck/sc-8183/documentation-add-ckeditor5-math-support branch January 22, 2025 23:00
nrichers added a commit that referenced this pull request Feb 1, 2025
* Updated mathematical formula support for content blocks (#631)

* README tweak

* Edited math formula instructions

* Updated documentation for Metrics Over Time (#633)

* Pulling in current latest notebooks

* Edits to Work with metrics over time

* Test adding anywidget dependency

* Yay it works

* Adding Juan's suggestion

* Pulling in latest updates to Log metics notebook

* Edits to Export documentation for validation reports (#635)

* Release notes to Sprint 66 (`25.01`) (#634) (#641)

* Generate initial release notes

* Initial edit pass

* Add versioning callout

* Edits & tweaks

* Get latest library source

* Edits

* Fix borked links

* Add toggle for demo notebook execution

* Fix stray git command

* Update site/releases/2025/2025-jan-31/release-notes.qmd



* Update site/releases/2025/2025-jan-31/release-notes.qmd



* Address review comment from Mehdi

* Add tech deep dive blog link to December release notes

* Address review comments

* Address more review comments

* Fix notebook link

* Add animated GIF for risk assessment prompt

* Fixing borked tech deep dive add

* Moving Enhancements into the right section

* Editing & cleanup

* Add missing math editor release notes & .tr some buttons because .tc is too messy

* Missing docs links

* Oops, wrong link

* last tweak i swear

* Fix some more broken links

* Grammar better

---------

Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
@nrichers nrichers added documentation Improvements or additions to documentation and removed internal Not to be externalized in the release notes labels Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants