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.
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
.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
).src/components/Markdown/Markdown.tsx
) which mainly just renders# Level 1 Headings
with theSectionHeader
component. It also adds a very minimal bit of styling to other elements. Unlike the currentChecklist
component, this does not attempt to render Markdown bulleted lists asIonList
s. With these changes, the Guide content became quite a bit more text-heavy, and theIonList
s didn't seem to suit it as well anymore.?raw
suffix.