Last updated

Project 28

Our walkthrough guide


We did not finish the OpenAI exercise and spent about 3.5 hours.

What made you smile?

  • Filters
  • API is improved since last week

What did you find confusing?

  • Configuration
    • RESOLVED. We found conflicts in the docs between codesets and filesets and it seems that filesets is the functional option. It also seems like the better name and seems more appropriate.
    • Inputs chunk markup results in invalid code. Why require valid comment syntax if inputs break it?
    • The slot tag is not documented. I was told slots are built in to Markdoc but they are not mentioned on the Markdoc website. The syntax is not clear.
  • Documentation
    • RESOLVED. We found conflicts in the docs between codesets and filesets and it seems that filesets is the functional option. It also seems like the better name and seems more appropriate.
    • RESOLVED. Examples use a mix of codesets, and options (which was changed to items but remains as options in at least one place).
    • Examples are lacking for conditions.
    • Docs spread across the sidebar navigation is a little harder to switch between and find.
  • Bugs Reunite
    • Copy/paste file in Reunite results in original file still selected (I expected the pasted copy to be selected, so that I can easily rename it).
    • Webview crash first time I changed the package.json value to the new training package.
    • Webview shifts horizontally. webview-moves.gif
    • Closing an active tab (when 6 tabs are open) takes a long time (about 6 seconds). Closing an inactive tab is instant.
    • Opening a file by clicking it on the filetree takes a long time when 6 tabs are open.
    • Switching tabs takes a long time when there are 6 tabs open.
    • Switching tabs still takes a long time when there are only 2 tabs open (about 3 seconds).
    • Didn't remember my word wrap preference.
    • Markdoc tags not loading at all: markdoc-tags-slow.png
  • Bugs code-walkthrough tag:
    • TBD
  • Bugs Realm
    • copy button in realm code samples doesn't always work
    • CSS file doesn't have any code highlighting
    • Tabs move and the UX doesn't feel right. tabs-moving.gif
    • page count tag has bad contrast in light mode
    • Code isn't highlighted as scroll down (only when scroll back up)
    • There is an extra line displayed in each code sample.
    • Adding more filters results in a wider left body content and more narrow code panel. This becomes a problem at specific page widths.
        filters={
      "server": {
        "label": "Server",
        "items": ["curl", "Python", "NodeJS", "Test", "Test2", "Test3", "Adam is testing a long name"],
        }
      }
    • Filters are only connected to the left-panel and don't spread across the right panel.
    • Spacing after inputs is smaller than between input and label. spacing-after-inputs.png
    • The preview slot would not render the image markdown.

WE DID NOT FINISH