illinois-cs241 / illinois-cs241.github.io Goto Github PK

Most of the students are not familiar with the command line, so a tutorial about that could be nice.

Every docs should have grading, submission, and academic integrity. No point in assignment writers manually adding this.

1. We are not the first result
2. The title is syllabus instead of something like "CS 241: Systems Programming"
3. The little text blub is about our cheating policy ...

for example if malloc appears in the text then we should wrap it in a link to the man pages.

better let have it pop up in a modal, so they don't lose their place in the docs?

cs241.com is available. Does anyone think it's worth buying?

I would like for hovering over a section title to reveal an anchor link.

Clicking on this should copy the link to your clipboard, so it's easier to cite parts of the docs.

http://jekyllrb.com/docs/configuration/

Someone should probably go through this list and see if we can turn on any cool features.

It would be nice if we listed who ran each section (on the labs page) so students know who to email.

Please make sure that this is generated using liquid templating, _data, and has an accompanying mobile friendly table. Make this a PR and I'll review it.

Ideally for some of the template stuff (especially with async requests) we should be building the site with react or something similar. Obviously, there is a lot of backlog because for us to get rid of jQuery we have to get rid of bootstrap js. That means we kinda need another columning system.

can we use this so that the modification time is statically generated?

https://github.com/gjtorikian/jekyll-last-modified-at

I think this can go either way. Currently the code blocks text wrap, but this doesn't play out well when we have ascii art in the documentation.

Maybe add something like this:

The textsize of mobile versions of the website should be increased.

Currently, our site is in a kinda state for accessibility. There should be a jekyll plugin that checks for accessibility on the final web page and sends a custom email if any violations were found.

https://developer.mozilla.org/en-US/docs/Learn/Accessibility/HTML

As I am taking a course that relates assistive technology, I've come to realize just how important it is that our course page be accessible to those with accessibility needs (the DOJ cares). Thus, we need to go through our course page and make sure it is very accessible.

WCAG 2.0: A guideline (standard) for accessible electronic information.

Letter to Universities from DOJ

Accessibility Policy: We should have one on our course website

they have their own workflow and what not

Language Barriers are a problem for a lot of students. We have a lot of text on the website that score very low in the readability score. While that many seem like a good this, we are teaching tough material -- it is not. This may be a false analogy, but if Feynman can explain most of his theoretical physics concepts with a high readability, so can we. We should add a stripped down parser to the website that scores the documentation on readability. The reading level should be high school to college undergraduate.

As with all metrics, it won't be perfect, but it'll get us some sort of metric on how students (especially ESL students) cope with reading documentation.

And before we have a discussion about "professional documentation" being terse, we are still an introductory course. We are supposed to ween them off of autograders from previous courses and center them around documentation; not make them read, hard-to-read docs and test you on them (I'm looking at you ECE 391 with your obscure 1990s keyboard buffer questions).

This will break some links. Fix that.

It would also be nice if we had some kind of code formatting as part of the precommit hook

This will make it so images won't render when hosted on the courses webserver.

https://courses.engr.illinois.edu/cs241/staff.html

We should have a page dedicated to late adds, so that they know what to do. Maybe even have the site redirect to that page for the first 2 weeks.

Like so

We are currently on 1.3.0 and the current version is 1.3.0 ... like an entire major revision.

lot of the liquid templating uses

{% if page.date %} <!-- this is a post -->

but I broke that since docs don't have dates anymore

For the default image on the course staff page can we get a different pokemon every time?

This website does it well:

https://gearoid.me/pokemon

Here is a blank template:

Table of content links for docs need to smooth scroll to appropriate section

We should check for dead links on precommit

The honor's section would like their own page on this site.

I think giving them a tab on the topnav and a markdown file would be cool :)

It would be nice if we could add LaTeX support to the docs.

From a user perspective it should just be like injecting it into the markdown.

I know that there a lot of javascript libraries that support his already

I think Jeffe does this best:

https://courses.engr.illinois.edu/cs473/integrity.html

A minor edit to clarify confusion

The "Testing" section has an incorrect example (example 2)

$ ./minixfs test.fs ls /directory
recursion
nice
$

Should be

$ ./minixfs test.fs ls /directory
nice
recursion
$

See https://piazza.com/class/is23se0b8a455k?cid=1663

Can someone run spell check once on all the pages.

I just think it's low hanging fruit that makes the course look a bit more polished.

http://localhost:4000/Pointers%20Gone%20Wild

are we okay with spaces?

http://stackoverflow.com/questions/8648390/syntax-highlighting-markdown-code-blocks-in-jekyll-without-using-liquid-tags

As the answer states jekyll allows for fence blocks for syntax highlighting (https://jekyllrb.com/docs/configuration/#redcarpet). We should convert to this flavor of markdown so that our docs render both on the webpage and in the github native markdown viewer.

"#1: 8/22 - 8/26" broke the js.

Suggest having liquid add the week number as part of the template

Maybe gray background?

So we have a lot of css/js in our head blocking the site from loading. We should introduce requirejs and stagger our dependencies loading so the site takes less time to load, this also helps with #37 because google and other search engines use speed metrics to determine rankings.

• Analytics should definitely not be in head.

We ought to set timeouts/caches as well as minify the files (maybe use grunt to automate that?)

currently materialize.js is just wrapping sections of the code in their appropriate blocks.

however I am wondering if I can I can do site.content : split:"##" to split the content into sections.

Once I have sections then I can split by newlines to get the title. join the rest of the everything by new lines. Finally markdownify after I am done wrapping things in divs.

Super useful for the beginning of the semester, and probably still worth writing up

This could be useful if someone wanted to make an api for our docs:

http://jekyllsnippets.com/excluding-jsonify-your-site/

Some features that could be made from this:

• search bar
• schedule
• analysis of entire site
• quick spell check lol

The padding on the sections in the docs are off on firefox. Use chrome to get a feel of the intended design.

We should change the templating engine put up placeholder for staff that haven't uploaded a photo yet.

I would highly like this photo:

Currently the staff photo has to be a .jpg since that's the way I hardcoded it (yes I am a bad person and deserve a special place in hell).

This is code is the root cause of the problem:
https://github.com/illinois-cs241/illinois-cs241.github.io/blob/master/staff.html#L18

I would like for the code to be format agnostic as in it should take any picture named .

Currently cs241.cs.illinois.edu has an A record for 151.101.44.133, which is an internal IP used by GitHub's CDN. (It isn't even the correct one—if you try host illinois-cs241.github.io you will see different IPs.) This could break at any time, including two hours before an MP is due. GitHub's documentation is pretty clear that it should be a CNAME to illinois-cs241.github.io, but for various reasons UIUC probably won't let us do this. We may have to fall back to self-hosting the HTML on web.engr.illinois.edu. Fortunately, the existing deploy code used for Travis might be easily repurposed to do this.

They look pretty blurry up close.

https://github.com/illinois-cs241/illinois-cs241.github.io/blob/master/images/favicons/android-icon-192x192.png

We should have a guide about how reading docs in a computer science course is not the same as reading an api for a large open source project. In the real world learning to skim documentation is a skill that pays off very well, since most of the time you are just trying to call one function.

Just doesn't fly with a programming code, since you are expected to implement every line of the documentation. Also thought experiment "would the ta bother to write this line of the docs if they thought it wasn't important??"

http://kramdown.gettalong.org/converter/html.html#toc

we should update the announcements and double check that they sync up with the lab and mp schedule