-
Notifications
You must be signed in to change notification settings - Fork 12
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
Major rewrite to Docs (do not merge this, only for review) #14
base: master
Are you sure you want to change the base?
Conversation
dfordivam
commented
Apr 4, 2018
- re-structured the existing documentation
- added a lot more content and some empty headings
@mightybyte fixed this.. There will be many more issues, so I think it would be better to review the docs with a proper preview. Perhaps we can merge these on a separate branch and preview on the readthedocs.io |
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.
Thanks for this! I didn't look at reflex_docs.rst
or reflex_dom_docs.rst
, so this is only a partial review. But this is great!
It seems there are two versions of readthedocs.io docs This central repo creates the docs here And my own repo is also creating docs here @ryantrinkle we have to fix this.. ie point the reflex-frp.org one to fetch the docs from the central repo But meanwhile this PR is available on |
|
Hmm.. the documentation has been for a while now. But I think now it is in a shape to advertise it on the README, other places... What reflex really need next is an home page! |
@dfordivam reflex-frp.org is now up :) Let's find a way to integrate your docs! |
Also, @ElvishJerricco @dfordivam, should I merge this? |
I raised a few concerns in comments when this was first opened. I'd prefer to see those fixed before merging this, especially the bits about |
@ryantrinkle the http://reflex-frp.org/ page points to a section of docs which doesn't exist. It seems the docs are being built from my repo, so it already has this PR |
@@ -1,14 +1,14 @@ | |||
-- A slightly contrived example just to demonstrate use of nested dynamics |
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.
This file has been added to reflex-examples repo reflex-frp/reflex-examples#17
So it will not be a part of docs here.
Hi All! I have done some fixes and added information about Obelisk to the docs. (See my last commit for details) This PR is quite old now, and will be better merged after taking care of #37 , by creating a fresh PR on top of that. |
The script is found at scripts/work-on.
app_devel_docs: Fix typos or old API
overview.rst: Fix typo
Fix missing append