MenkeTechnologies/zpwr

Readme Update: Assignee, Michael Dimmitt

MichaelDimmitt opened this issue · 1 comments

This issue is intended to be the base for version 2.0 of this
pr #12 (adding collapsable sections to the readme).

Once sections exist in the readme we can make certain sections collapsed by default and all other sections expanded by default. I am thinking all of the keybindings sections make this readme huge and distract from features. Likewise people will still be able to search keybindings by looking at the raw files or by expanding those sections. #12

Why make a version 2?

Previously, I did not feel comfortable with the change due to how much of a headache updating the readme could become.

Therefore this change will focus on writing scripts to

  1. decode the html out of the readme for easy editing
  2. encode the now edited readme back into html sections to give collapsable sections that makes the readme easy to parse for existing and future users.

Plan:

  1. make a script to add
    a. <details></details> for each header
    b. wrap the headers in <summary></summary>
    c. adds newlines where appropriate to make the html work in markdown and the other markdown still operate correctly.

  2. make a script to remove
    a. <summary></summary><details></details> and relevant newlines.

sounds good