ericsson / c3-web-guide Goto Github PK

The golang and rust-lang tutorials tend to have some initial code state, a problem statement, some additional information explaining the new thing to be used to solve the problem and then an expected success state.

At the time of writing, the tutorial is not so interactive beyond demonstration. It would be good to have some more advanced hands-on pages where one is encouraged to use the API docs and write or modify code to learn how to use the APIs, rather than just reading some descriptive text, reading the code and then running it.

• https://ericsson.github.io/c3-web-guide/#display-name
  • anytime -> any time
• https://ericsson.github.io/c3-web-guide/#rooms
  • connect -> connects (central component that connects users together)
  • whith -> with
• https://ericsson.github.io/c3-web-guide/#messaging
  • on -> for (starts listening for new messages)
  • sendMessages -> sendMessage (sendMessage functions - grammatically sendMessage is specifying the type of the functions)
• https://ericsson.github.io/c3-web-guide/#webrtc
  • data transferring -> data transfer

I noticed that there were a number of promise chains that did not have any error case handling. I think it is good practice to always .catch() unless you have a good reason not to.

Instead of using an object where the key is the name of the page and the value is an object with a pageNumber key, perhaps it would be better to use the implicit ordering of an array. So perhaps something like this:

[
  ...
  {
    "pageId": "example-page",              // The ID of the page that also will be used in the URL. Should be a slugged version of the title.
    "title": "Example Page",               // The title of the page
    "description": "Example description.", // The description of the page that will be shown on the home page.
    "text": "pages/example-page.md",       // The text which will be shown in the guide.
    "code": "pages/example-page.js",       // The code that will be shown in the editor beside the text.
    "readOnly": false                      // If the code in the editor should be editable and runnable or not.
  },
  ...
]

After clicking end call on the WebRTC page, the camera is still active.

Both code and line numbers are somehow left-aligned in the code input box which places them on top of each other.