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

Interactive SICP-JS: Improve readability + minor fixes #1796

Merged
merged 16 commits into from
Jun 16, 2021

Conversation

samuelfangjw
Copy link
Contributor

@samuelfangjw samuelfangjw commented Jun 16, 2021

Description

  1. Improved readability by altering max width, line-height and font size.

Screenshot 2021-06-16 at 4 04 31 PM

  1. Fixed formatting issues on index page. Previously, title and contents were not aligned properly. Also updated adapters names.

Screenshot 2021-06-16 at 7 16 56 PM

  1. Remove dead code from syntax highlighting library that was previously bundled by webpack.
    before:
    Screenshot 2021-06-16 at 4 30 39 PM
    after:
    Screenshot 2021-06-16 at 4 28 12 PM

  2. Fix figure margins and text alignment. Figures now have margins on the top and bottom. Text alignment for code snippets no longer centered (left align now).

Screenshot 2021-06-16 at 7 29 53 PM

  1. Simplify parsing of containers, defined as elements that have a title and hold child elements. Previously, tags such as SECTION, SUBSECTION, SUBSUBSECTION etc. were all handled separately, even though they are parsed in same way. After this PR, the tags will all be parsed as section tags.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Code quality improvements

How to test

Checklist

1 & 2: verify page is as shown in the screenshots
3: build the project using yarn build, the build/static/js folder should look like the screenshots in the description. Syntax highlighting should still work.
4: verify figures in chapter 5 (e.g. 5.1.1) are left aligned (was centre previously)
5: Verify pages load correctly and titles at the top of each page can be seen.

  • I have tested this code
  • I have updated the documentation

@samuelfangjw samuelfangjw marked this pull request as draft June 16, 2021 08:43
@samuelfangjw samuelfangjw marked this pull request as ready for review June 16, 2021 09:04
@coveralls
Copy link

coveralls commented Jun 16, 2021

Pull Request Test Coverage Report for Build 942821044

  • 4 of 4 (100.0%) changed or added relevant lines in 3 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.008%) to 30.241%

Totals Coverage Status
Change from base Build 942319078: 0.008%
Covered Lines: 3231
Relevant Lines: 9865

💛 - Coveralls

@samuelfangjw samuelfangjw marked this pull request as draft June 16, 2021 09:41
@samuelfangjw samuelfangjw marked this pull request as ready for review June 16, 2021 13:00
@samuelfangjw
Copy link
Contributor Author

Ready to merge after this PR is merged.

Copy link
Member

@martin-henz martin-henz left a comment

Choose a reason for hiding this comment

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

All looks fine

@martin-henz martin-henz merged commit a617212 into source-academy:master Jun 16, 2021
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.

None yet

3 participants