-
-
Notifications
You must be signed in to change notification settings - Fork 323
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
rename idom to reactpy #892
Conversation
7a1c1de
to
fce5cc0
Compare
There's a number of different png and gif files that will need to be updated to use the ReactPy name before this can go in. I have intentionally left the names of those files unchanged so they can be more easily found by searching for files with IDOM in their names. |
I am going to begin work on the new docs based off import paths in this PR |
6bfdc82
to
ea07129
Compare
@Archmonger, assuming no other changes are needed, I think we're ready to release 1.0 and execute the rename. |
|
@Archmonger I think this is ready to go. The only thing that will be left to do after this is to recreate two gifs that can't be recreated until we release. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That was a long read 😅
The main nitpicks I have are related to wordsmithing the readme to increase information density, reduce jargon usage, and increase clarity.
src/reactpy/__init__.py
Outdated
__author__ = "idom-team" | ||
__version__ = "1.0.0-a6" # DO NOT MODIFY | ||
__author__ = "reactive-python" | ||
__version__ = "1.0.0-a5" # DO NOT MODIFY |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
accidental __version__
revert?
I think I condensed it down to one paragraph:
|
Minor wordsmithing on the first few sentences:
Last sentence becomes unneeded if we're going for a hyper-minimal summary. But if we're keeping it, then it'll need a new line.
|
by those without web development experience while also being powerful enough to grow | ||
with your ambitions. | ||
|
||
<table> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something I'm now realizing, why are we using HTML tables instead of markdown tables? They should accomplish the same thing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, the md table was quite hard to read in raw text with all the links.
<th>Supported Servers</th> | ||
<th>Supported Integrations</th> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should be consistent about our usage of verbiage. ASGI Python Frameworks are not servers. The word server only applies to things like hypercorn
, uvicorn
, and gunicorn
.
- From the perspective of IDOM, they are backends.
- From the perspective of those packages, they are web frameworks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about “built-in backends” and “supported frameworks”?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Neither option gives a good indication of why we separate these two categories. Maybe we say something like
ReactPy Backends
/ External ReactPy Backends
closes: #888
Checklist
Please update this checklist as you complete each item:
changelog.rst
has been updated with any significant changes.