-
-
Notifications
You must be signed in to change notification settings - Fork 317
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 Overhaul #705
Readme Overhaul #705
Conversation
Co-authored-by: Ryan Morshead <[email protected]>
…/idom into readme-summary-revise
Overall I think this is better that what's there presently. I'd like to revisit the README again, but maybe that can wait till the project rename. In short, I think I'd want to reduce the number of links per-paragraph (ideal just one or two) and for the links which we do have, to link to the docs. I'm kind of thinking it might be logical to link to the top-level guide sections (e.g. Getting Started, Creating Interfaces, Adding Interactivity, etc). |
Haven't had time to read through completely and look at the md render yet, but on first glance i like this a lot |
When reading the rendered version it still feels a bit busy. I think we can probably remove some of the in-line code blocks since those aren't really essential. The last section with the list of supported frameworks can be turned into bullets too. |
Making it into a list takes up too much vertical space, which feels a bit awkward. I'll see what I can do to make the last paragraph feel less busy. |
I tried using a table, which is more compact than a list. This leaves the potential for us to add an "Upcoming Support" section, if the situation ever arises. Let me know what you think. |
@rmorshea Is this ready for merge? |
I don't have the ability to merge in IDOM core. |
This changes the readme to more prominently highlight our key features, including: