Skip to content
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

Refresh Guide tab content #239

Merged
merged 6 commits into from
Feb 28, 2025
Merged

Conversation

pkalita-lbl
Copy link
Collaborator

Fixes #199

Summary

The main purpose of these changes is to update the content of the Guide tab in accordance with various team member contributions (see the Guide Tab Content doc in the squad folder). While moving content from the Google doc into the codebase I took the opportunity to streamline how we incorporate Markdown content in the app.

Details

  • Currently different sections of the Guide tab have their content stored in separate .md.ts files, which are TypeScript files, but they export string variables that hold Markdown content. I found that a little cumbersome and also a bit restrictive. With these changes, all the Markdown-based content for the Guide tab is stored in one plain Markdown file (src/pages/GuidePage/md/guide-page.md).
  • I added a new component to render Markdown text (src/components/Markdown/Markdown.tsx) which mainly just renders # Level 1 Headings with the SectionHeader component. It also adds a very minimal bit of styling to other elements. Unlike the current Checklist component, this does not attempt to render Markdown bulleted lists as IonLists. With these changes, the Guide content became quite a bit more text-heavy, and the IonLists didn't seem to suit it as well anymore.
  • I'm using Vite's static asset handling functionality to load the Markdown content by using the ?raw suffix.
  • The orphaned Checklist page has been removed, and all remaining pages/components uses the "Guide" nomenclature.

Copy link
Collaborator

@eecavanna eecavanna left a comment

Choose a reason for hiding this comment

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

Thank you for implementing this, including refactoring the way the Markdown content was stored and soliciting content feedback from team members. LGTM!

Co-authored-by: eecavanna <134325062+eecavanna@users.noreply.github.com>
@pkalita-lbl pkalita-lbl merged commit 2287106 into main Feb 28, 2025
1 check passed
@pkalita-lbl pkalita-lbl deleted the issue-199-guide-content-refresh branch February 28, 2025 00:57
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.

Add guidance around setting up a submission in the submission portal first
2 participants