JeremyYao commented on issue #1149:
URL: 
https://github.com/apache/daffodil-vscode/issues/1149#issuecomment-2725442635

   > Some thoughts:
   > 
   > * Noticed the page has a mix of Markdown and HTML elements. A bit 
confusing to maintain or to read through.
   > * We should change the steps for Open Data Editor, Open Infoset Diff View, 
and Open Infoset View to have them be checked so that the user can see what 
they look like when they're debugging a schema
   > * Needs more steps beyond the last step of saving the config. Include 
sections or screenshots walking through what the extension looks like as it's 
actively debugging a schema file with screenshots of the data editor, infoset 
view and infoset diff view.
   > * Every table in the page has a tiny top section
   >   
![Image](https://github.com/user-attachments/assets/901570c2-c21d-4608-95ba-096e7673544a)
   
   Looked into some bullet points a bit more. 
   
   ### First bullet point regarding mix of Markdown + HTML
   Due to the limitations of how GitHub handles markdown, it's not possible to 
have markdown-style bullet points inside of a Markdown table cell per 
https://stackoverflow.com/questions/46205748/github-readme-markdown-to-include-bullet-points-inside-of-table.
 
   
   The current workaround is to utilize HTML elements inside of Markdown table 
cells: 
https://stackoverflow.com/questions/37934662/how-to-write-bullet-list-in-markdown-table
   
   This post suggests just writing in pure HTML, 
https://stackoverflow.com/questions/19950648/how-to-write-lists-inside-a-markdown-table,
 to circumvent the issue and to have higher degrees of customizability. 
   
   ### Fourth bullet point: Every table in the page has a tiny top section
   
   
![Image](https://github.com/user-attachments/assets/e5513c62-e869-4927-b078-54729759b306)
   
   This is due to the div elements at the top of every markdown table. The top 
cells of markdown tables are treated as headers and the text has custom 
styling. 
   
   
![Image](https://github.com/user-attachments/assets/653e6d3a-eacb-44d7-9585-57e43693182a)
   
   
![Image](https://github.com/user-attachments/assets/795ccf97-8eae-47bf-8ad0-c5e29fb62562)
   
   I suspect the top divs are used to circumvent the limitations of the forced 
table header styling. 
   
   ### Discussion + Recommendations?
   @hdalsania , do you think we should restructure the entire wiki page to 
utilize HTML or stick to using Markdown? Note that if we were to stick to 
entirely using markdown, we would have to go away with the table/cell 
formatting aspect of the page. (Images and bullet-points wouldn't be 
side-by-side anymore). 
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to