Audit & fix Information.md #81

Yoda-Canada · 2021-11-15T16:01:55Z

Fixes #44
Steps done to modify and check Information.md:

Fixed images work in dark modes. The memory model image's downward arrows and the letter in the bottom right corner are not clear in dark modes. I save the image in the image folder and link it to the information page. The issue is fixed.
Added alt text for diagram images.
The images can't display in all models. Change all the image path from "/img/.jpg" to "../../static/img/.jpg". The issue is fixed.
Fix Frontmatter for the page to include id, title, slug, and description.
Replace blockquote with Admonitions for clarity.

AndreWillomitzer · 2021-11-15T21:58:37Z

@Yoda-Canada A few things that may be causing the deployment to fail and I noticed:

To fix the dark mode image issue, I would suggest wrapping them in a <span> tag and adding class "mdImg" to it. Then, when your change gets merged it will have the global CSS applied that I did in my merged PR:

.mdImg > p > img{
  background-color: #ffffff;
}

I am not actually sure you needed to add <img> and <div> tags around the images. For my fix all I did was add the alt description to the Markdown image itself and then wrap it in a <span>. The difference between div and span are that divs are block elements, and span are inline. By using span, you won't mess with any mobile/screen resizing by accident.
For regular text, I don't believe it is necessary to wrap them in <p> tags because we're using a Markdown file and so regular text that isn't preceeded by a symbol like ### is treated like normal text.

Otherwise, great job looks like you put tons of effort in to the changes 🚀 !

suhhee1011 · 2021-11-15T22:24:58Z

package.json

    "execa": "^5.1.1",
    "mr-pdf": "^1.0.7",
    "wait-on": "^6.0.0"
+=======
+    "docusaurus": "^1.14.7"
+>>>>>>> issue-44
  }


I think you forgot to erase the <<<<<<<<HEAD, ======, >>>>>>issue-44tag when you merge it to the main branch on your repository.

Good point that could be why deployment failed. Nice spot :D

@suhhee1011 Thank you, I have modified it.

dhillonks · 2021-11-16T00:21:55Z

docs/A-Introduction/information.md

@@ -30,9 +34,12 @@ Since bits are too numerous to handle individually, modern computers transfer an

 The fundamental addressable unit of RAM is the byte.  One byte consists of 2 nibbles.  Each nibble consists of 4 bits.

-![](/img/bytenibbit.jpg)
+<div  align="left">
+<img src="../../static/img/bytenibbit.jpg" alt="A bytes tree image" />


The alt text could be more descriptive. For instance: Tree showing relative sizes of bit, nibble and byte

thx, I have modified.

docs/A-Introduction/information.md

oliver-pham · 2021-11-16T20:02:31Z

I think you should remove hint-report/https-webhint-io.html and yarn.lock from your commit. These files are generated locally and not relevant to your changes.

xguhx · 2021-11-16T21:53:24Z

docs/A-Introduction/information.md

 sidebar_position: 2
+title: Information
+slug: /A-Introduction/information


Hey, great work on this Md file,
Something that I noticed was:

Slug should be standardized in small caps and without the "A-"
Check https://github.com/Seneca-ICTOER/IPC144/issues/64 for more details.

Thank you.

thx, I have modified.

Yoda-Canada · 2021-11-17T04:02:13Z

@Yoda-Canada A few things that may be causing the deployment to fail and I noticed:

To fix the dark mode image issue, I would suggest wrapping them in a <span> tag and adding class "mdImg" to it. Then, when your change gets merged it will have the global CSS applied that I did in my merged PR:
.mdImg > p > img{
  background-color: #ffffff;
}
I am not actually sure you needed to add <img> and <div> tags around the images. For my fix all I did was add the alt description to the Markdown image itself and then wrap it in a <span>. The difference between div and span are that divs are block elements, and span are inline. By using span, you won't mess with any mobile/screen resizing by accident.

For regular text, I don't believe it is necessary to wrap them in <p> tags because we're using a Markdown file and so regular text that isn't preceeded by a symbol like ### is treated like normal text.

Otherwise, great job looks like you put tons of effort in to the changes 🚀 !

@AndreWillomitzer Thank you, I have modified all you mentioned.

Yoda-Canada · 2021-11-17T04:57:42Z

I think you should remove hint-report/https-webhint-io.html and yarn.lock from your commit. These files are generated locally and not relevant to your changes.

@oliver-pham I have added these files in the .gitignore, thank you!

Yoda-Canada · 2021-11-17T15:37:59Z

I think you should remove hint-report/https-webhint-io.html and yarn.lock from your commit. These files are generated locally and not relevant to your changes.

@oliver-pham yarn.lock shouldn't remove.

Yoda-Canada

thx, I have modified.

Yoda-Canada · 2021-11-17T03:04:37Z

docs/A-Introduction/information.md

@@ -30,9 +34,12 @@ Since bits are too numerous to handle individually, modern computers transfer an

 The fundamental addressable unit of RAM is the byte.  One byte consists of 2 nibbles.  Each nibble consists of 4 bits.

-![](/img/bytenibbit.jpg)
+<div  align="left">
+<img src="../../static/img/bytenibbit.jpg" alt="A bytes tree image" />


thx, I have modified.

Yoda-Canada · 2021-11-17T05:48:01Z

package.json

    "execa": "^5.1.1",
    "mr-pdf": "^1.0.7",
    "wait-on": "^6.0.0"
+=======
+    "docusaurus": "^1.14.7"
+>>>>>>> issue-44
  }


@suhhee1011 Thank you, I have modified it.

mqnguyen5 · 2021-11-18T02:19:15Z

docs/A-Introduction/information.md


+:::

 ### Sets of Bytes



I would suggest escaping any * character that represents multiplication (line 122-128), as some of them will get converted into _ after being formatted with Prettier. See #56 for more info.

I would suggest escaping any * character that represents multiplication (line 122-128), as some of them will get converted into _ after being formatted with Prettier. See #56 for more info.

Did you mean the multiplication from line 115-122?

I have modified them, thx

Yoda-Canada · 2021-11-18T04:12:07Z

Since the commits can't be squashed to one, I close this PR and open a new PR #101. Thanks to all contributors.

Yoda-Canada added 2 commits November 15, 2021 00:34

update information page

87a25e1

merge upstream to main local

681d5f4

suhhee1011 reviewed Nov 15, 2021

View reviewed changes

dhillonks suggested changes Nov 16, 2021

View reviewed changes

xguhx suggested changes Nov 16, 2021

View reviewed changes

Yoda-Canada and others added 7 commits November 17, 2021 00:39

update by PR#81 comment

bc1ef66

update package.json

8ee2e3b

Merge branch 'issue-44'

e293431

change slug

96330b5

Merge branch 'issue-44'

8bb3d66

Delete https-webhint-io.html

c96684c

Delete yarn.lock

a98d465

Yoda-Canada commented Nov 17, 2021

View reviewed changes

Yoda-Canada and others added 6 commits November 17, 2021 11:28

update imformation page

237a586

Merge remote-tracking branch 'origin'

47e1cce

update information page

927e2fa

merge issue-44new

06ccbf3

Merge branch 'main' of https://github.com/Seneca-ICTOER/IPC144

2f37d45

Merge branch 'Seneca-ICTOER:main' into main

1db8151

vercel bot deployed to Preview November 18, 2021 01:44 View deployment

mqnguyen5 suggested changes Nov 18, 2021

View reviewed changes

pull origin main

20cb79d

vercel bot had a problem deploying to Preview November 18, 2021 03:02 Failure

update \*

1df9749

vercel bot had a problem deploying to Preview November 18, 2021 03:30 Failure

Yoda-Canada mentioned this pull request Nov 18, 2021

New PR - Audit & fix Information.md #101

Closed

Yoda-Canada closed this Nov 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Audit & fix Information.md #81

Audit & fix Information.md #81

Yoda-Canada commented Nov 15, 2021

AndreWillomitzer commented Nov 15, 2021 •

edited

Loading

suhhee1011 Nov 15, 2021

AndreWillomitzer Nov 15, 2021

Yoda-Canada Nov 17, 2021

dhillonks Nov 16, 2021

Yoda-Canada Nov 17, 2021

oliver-pham commented Nov 16, 2021

xguhx Nov 16, 2021

Yoda-Canada Nov 17, 2021

Yoda-Canada commented Nov 17, 2021

Yoda-Canada commented Nov 17, 2021

Yoda-Canada commented Nov 17, 2021

Yoda-Canada left a comment

Yoda-Canada Nov 17, 2021

Yoda-Canada Nov 17, 2021

mqnguyen5 Nov 18, 2021

TueeNguyen Nov 18, 2021

Yoda-Canada Nov 18, 2021

Yoda-Canada commented Nov 18, 2021

Audit & fix Information.md #81

Audit & fix Information.md #81

Conversation

Yoda-Canada commented Nov 15, 2021

AndreWillomitzer commented Nov 15, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oliver-pham commented Nov 16, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yoda-Canada commented Nov 17, 2021

Yoda-Canada commented Nov 17, 2021

Yoda-Canada commented Nov 17, 2021

Yoda-Canada left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yoda-Canada commented Nov 18, 2021

AndreWillomitzer commented Nov 15, 2021 •

edited

Loading