-
Notifications
You must be signed in to change notification settings - Fork 1
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
Documentation and QA #177
Conversation
* 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
@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) |
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. |
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. |
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. |
@zhangjuliet Let's try to merge this for now so that we can consolidate all of our changes. |
I'm not entirely sure we need a separate page, but let me think about that for a minute.
Did you have any examples in mind?
Good renaming suggestion, I'll make that change.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
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.