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

Major rewrite to Docs (do not merge this, only for review) #14

Open
wants to merge 21 commits into
base: master
Choose a base branch
from

Conversation

dfordivam
Copy link
Member

  • re-structured the existing documentation
  • added a lot more content and some empty headings

doc/installation.rst Outdated Show resolved Hide resolved
@dfordivam
Copy link
Member Author

@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
or we can merge these over master and then fix issues.

Copy link

@ElvishJerricco ElvishJerricco left a 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!

code-snippets/StaticBuilder.hs Show resolved Hide resolved
doc/app_devel_docs.rst Outdated Show resolved Hide resolved
doc/app_devel_docs.rst Outdated Show resolved Hide resolved
doc/app_devel_docs.rst Show resolved Hide resolved
doc/installation.rst Show resolved Hide resolved
@dfordivam
Copy link
Member Author

It seems there are two versions of readthedocs.io docs

This central repo creates the docs here
http://reflex-frp.readthedocs.io/en/latest/

And my own repo is also creating docs here
http://docs.reflex-frp.org/en/latest/

@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
http://docs.reflex-frp.org/en/latest/

@srid
Copy link

srid commented Apr 10, 2018

Holly crap! When did reflex get documentation?!?!

https://news.ycombinator.com/item?id=16800643

@dfordivam
Copy link
Member Author

dfordivam commented Apr 10, 2018

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!

@ryantrinkle
Copy link
Member

@dfordivam reflex-frp.org is now up :) Let's find a way to integrate your docs!

@ryantrinkle
Copy link
Member

Also, @ElvishJerricco @dfordivam, should I merge this?

@ElvishJerricco
Copy link

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 delay and cabal.

@dfordivam
Copy link
Member Author

@ryantrinkle the http://reflex-frp.org/ page points to a section of docs which doesn't exist.
http://reflex-frp.readthedocs.io/en/latest/architecture.html#overview-of-reflex-basics

It seems the docs are being built from my repo, so it already has this PR
I have nothing to add to the delay point raised by ElvishJerricco, so it is ready to be merged from my side...

doc/reflex_docs.rst Outdated Show resolved Hide resolved
@@ -1,14 +1,14 @@
-- A slightly contrived example just to demonstrate use of nested dynamics
Copy link
Member Author

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.

@dfordivam dfordivam changed the title Major rewrite to Docs Major rewrite to Docs (do not merge this, only for review) Nov 19, 2018
@dfordivam
Copy link
Member Author

Hi All!

I have done some fixes and added information about Obelisk to the docs. (See my last commit for details)
This PR is currently live at http://docs.reflex-frp.org/en/latest/index.html

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants