-
Notifications
You must be signed in to change notification settings - Fork 124
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
Clean up default init template #2165
Conversation
Update in b7c8cbd: The placeholder text in the
Some of the whitespaces in |
Hi @lhw-1! Thanks for the PR! Just a small nit in the home page under "Heading 3". I noticed that for the third panel: "Expanded panel", the panel is meant to be expanded on load, however, it seems to be missing the |
Thanks for looking through the changes @itsyme!
This is the current output for Essentially, the minimized panel at the top is set to change its header back to "Expanded panel" once it is no longer minimized (by clicking on it at least once): Additionally, the expanded panel at the bottom will become a minimized panel as well after clicking the "X" button: So I believe that the heading "Expanded panel" refers not to having the panel already expanded on load, but to differentiate between a minimized and an expanded panel - I don't think including the property for this bottom panel is a necessity, since it could potentially further obfuscate the meaning of "expanded" for new users (if it already isn't doing so...). Regardless, what you've pointed out is still a good example to showcase for panels (especially to differentiate between these two meanings of "expanded"), so it may be worth including another panel at the bottom that showcases this property specifically! On that note, it might also be worth looking into improving the template to be more comprehensive to a new user, instead of having filler texts. With reference to the above example, some brief explanation of the features could be more handy than the standard |
If you add the expanded property in, does it look better/make the example clearer? I think this is a good point - I re-read the conversation above at least twice to understand what this is all about, it's definitely not the clearest example that we can give. Would be great if we can modify this part slightly to make the example clear. FYI the deployed output of the standard template can be viewed here. |
Right now, the wording we are using in the template for "Expanded panel" vs "Minimized panel" is referring to the panel header, and not the panel body itself, which is what the |
Sure let's try that 🚀 |
As per suggestions above, I've included a new panel in 4ebf484: Which makes more sense to me 😄 |
Also, given that this PR has been up for quite some time & there has not been more suggestions, I think it's fine to consider this PR as complete. (Requesting for approving reviews!) |
What is the purpose of this pull request?
Overview of changes:
Cleans up the default template for
markbind init
, consisting of minor changes in wording, etc.As this PR is not tied to a specific issue, any suggestions on improving the current template (in terms of pure cosmetics without changing the functionalities) are welcome.
Anything you'd like to highlight/discuss:
Testing instructions:
Proposed commit message: (wrap lines at 72 characters)
Clean up default init template
Checklist: ☑️