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 Overhaul #705

Merged
merged 30 commits into from
Apr 16, 2022
Merged

Conversation

Archmonger
Copy link
Contributor

@Archmonger Archmonger commented Mar 9, 2022

This changes the readme to more prominently highlight our key features, including:

  • ReactJS based design
  • Hooks
  • Events
  • NPM imports
  • JavaScript components
  • Multi web framework support

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Archmonger Archmonger changed the title Update readme summary Readme Overhaul Mar 23, 2022
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@rmorshea
Copy link
Collaborator

rmorshea commented Apr 6, 2022

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).

@rmorshea
Copy link
Collaborator

rmorshea commented Apr 9, 2022

Haven't had time to read through completely and look at the md render yet, but on first glance i like this a lot

@rmorshea
Copy link
Collaborator

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.

@Archmonger
Copy link
Contributor Author

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.

@Archmonger
Copy link
Contributor Author

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.

@Archmonger
Copy link
Contributor Author

@rmorshea Is this ready for merge?

@rmorshea rmorshea added the flag-no-changelog Add to a pull request that does not require a changelog label Apr 16, 2022
@Archmonger
Copy link
Contributor Author

I don't have the ability to merge in IDOM core.

@rmorshea rmorshea merged commit 3242da6 into reactive-python:main Apr 16, 2022
@Archmonger Archmonger deleted the readme-summary-revise branch April 16, 2022 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flag-no-changelog Add to a pull request that does not require a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants