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

Documentation and QA #177

Merged
merged 11 commits into from
Jan 6, 2023
Merged

Documentation and QA #177

merged 11 commits into from
Jan 6, 2023

Conversation

bliutech
Copy link
Member

Did some review of the existing content and some documentation updates. Reviewed pages "Intro" to "Creation and Deletion". Documentation still needs to be slimmed down and also the rest of the pages need some content fixes as well so this is left open to slowly fix those.

* added some assets
* updated some typos
* fixed some links
* updated file names for better standardization
* refactored style sheet to scss
* moved style sheet placement to styles/
* adjusted props types in Task.tsx to only allow strings to be passed to the name
* fixed localStorage issue with JSX elements being converted to strings by only allowing strings
* updated content and names on the creation/deletion page
@bliutech bliutech marked this pull request as draft December 29, 2022 20:54
@bliutech bliutech linked an issue Dec 29, 2022 that may be closed by this pull request
@bliutech bliutech requested a review from zhangjuliet December 29, 2022 20:55
@bliutech
Copy link
Member Author

@zhangjuliet thoughts on moving the ending page Tux to its own page? I think it would be nice to have the permissions content on its own page and have the ending page be by itself. I could also quickly put together a progress check as well? (show a ratio of how many completed tasks ex. 10/21)

image

@bliutech
Copy link
Member Author

The "Creation and Deletion" page is now getting a bit cluttered and it feels like its missing some of the "Examples" like some of the other sections before the task itself. Maybe it's worth splitting up into a "Creation" page, a "Deletion" page, and a "Moving and Copying" page? I see #175 but might be a bit tricky to do subpages as opposed to its own pages.

@bliutech
Copy link
Member Author

bliutech commented Dec 29, 2022

The "Piping" page might be worth renaming to "Input and Output (I/O)" and this transitions nicely into "I/O Redirection". I also realized that we don't have a task that uses the "|" operator. Maybe we should create one on its own page and call it "Piping" instead. I think we are also missing usage/discussion about the "<" operator as well.

@bliutech
Copy link
Member Author

@zhangjuliet thoughts on moving the ending page Tux to its own page? I think it would be nice to have the permissions content on its own page and have the ending page be by itself. I could also quickly put together a progress check as well? (show a ratio of how many completed tasks ex. 10/21)

image

Another idea similar to this is to also provide a page where there's just a terminal for them to play with afterwards. Similar to PicoGym's web terminal. Probably leave a note on there somewhere that our terminal is very limited lol.

@bliutech bliutech marked this pull request as ready for review January 5, 2023 21:14
@bliutech
Copy link
Member Author

bliutech commented Jan 5, 2023

@zhangjuliet Let's try to merge this for now so that we can consolidate all of our changes.

@zhangjuliet
Copy link
Contributor

zhangjuliet commented Jan 6, 2023

@bliutech

@zhangjuliet thoughts on moving the ending page Tux to its own page? I think it would be nice to have the permissions content on its own page and have the ending page be by itself. I could also quickly put together a progress check as well? (show a ratio of how many completed tasks ex. 10/21)

I'm not entirely sure we need a separate page, but let me think about that for a minute.
I like the idea of a progress check though! Would that be a stat that appears on every page and updates as the user goes along, or just a summary stat at the very end? If it's the latter, a separate Ending page would be reasonable, otherwise I'm not sure we need another page.


The "Creation and Deletion" page is now getting a bit cluttered and it feels like its missing some of the "Examples" like some of the other sections before the task itself. Maybe it's worth splitting up into a "Creation" page, a "Deletion" page, and a "Moving and Copying" page? I see #175 but might be a bit tricky to do subpages as opposed to its own pages.

Did you have any examples in mind?
Yeah, I agree that splitting into the three pages might reduce clutter, but I'd check with @archishadatta about the status of the subpages.


The "Piping" page might be worth renaming to "Input and Output (I/O)" and this transitions nicely into "I/O Redirection". I also realized that we don't have a task that uses the "|" operator. Maybe we should create one on its own page and call it "Piping" instead. I think we are also missing usage/discussion about the "<" operator as well.

Good renaming suggestion, I'll make that change.
Oh yeah according to the content doc, there was supposed to be a task for |. I'll take a look at that, see if we need to add one.
We're also missing >> and << lol but I think we cut some operators because the lab was getting too long.


Another idea similar to this is to also provide a page where there's just a terminal for them to play with afterwards. Similar to PicoGym's web terminal. Probably leave a note on there somewhere that our terminal is very limited lol.

Cool idea, but I'm not sure we need a separate page for this since the user can just play with the terminal on any page.

Copy link
Contributor

@zhangjuliet zhangjuliet left a comment

Choose a reason for hiding this comment

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

lgtm

@zhangjuliet zhangjuliet merged commit 9bea8d4 into main Jan 6, 2023
@zhangjuliet zhangjuliet linked an issue Jan 6, 2023 that may be closed by this pull request
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.

Finalize documentation and check content
2 participants