Skip to content
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

Readme Update: Assignee, Michael Dimmitt #19

Open
MichaelDimmitt opened this issue Nov 16, 2023 · 1 comment
Open

Readme Update: Assignee, Michael Dimmitt #19

MichaelDimmitt opened this issue Nov 16, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@MichaelDimmitt
Copy link
Contributor

MichaelDimmitt commented Nov 16, 2023

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.

@MenkeTechnologies
Copy link
Owner

sounds good

@MenkeTechnologies MenkeTechnologies added the documentation Improvements or additions to documentation label Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants