refactor: rewrite profile readme in quarto#54
Open
kelly-sovacool wants to merge 25 commits intomainfrom
Open
Conversation
for more information, see https://pre-commit.ci
kelly-sovacool
force-pushed
the
refactor-quarto
branch
from
9e505f5 to
7327e73
Compare
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.
Changes
Re-write the make_readme action and scripts as a quarto document for a simplified design. Removes a lot of boilerplate code and makes the readme easier to understand. Instead of calling
make_readme.sh, the readme is now updated withquarto render profile/README.qmd. The content in the rendered file (profile/README.md) is nearly identical to the original, with the only differences being line wrapping.You can test how the README file is rendered without running the Python code chunks with:
Issues
fixes #45
PR Checklist
(
Strikethroughany points that are not applicable.)[ ] Write unit tests for any new features, bug fixes, or other code changes.[ ] Update docs if there are any API changes.[ ] UpdateCHANGELOG.mdwith a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/