New docs polish #211
New docs polish #211
Conversation
|
|
||
| pygments_style = 'sphinx' | ||
| pygments_style = 'algol_nu' |
There was a problem hiding this comment.
Would love to get a slightly modified version of this with just a bit more contrast in the palette.
There was a problem hiding this comment.
Thanks @goodboy, nice docs polish! I have some small comments but nothing outstanding, it's looking solid for me!
Also, great theme from https://sphinx-book-theme.readthedocs.io/, seems to have a clean visual style but still very robust (with the margin elements, code blocks, TOC navigation...) 😃
docs/README.rst
Outdated
| the problem of *unbounded non-determinism* (which was the whole point | ||
| for creation of the model in the first place). | ||
|
|
||
| Again, ``tractor`` does seem to adhere to the base requirements of |
There was a problem hiding this comment.
I would remove the Again & does seem to parts and replace them with a more "certain / to the point"? statement:
tractoraims to adhere to the base requirements of an "actor model".
docs/README.rst
Outdated
| From the author's mouth, **the only thing required** is `adherance to`_ | ||
| the `3 axioms`_, *and that's it*. | ||
|
|
||
| To get more fired up on the matter, please read these issues: |
There was a problem hiding this comment.
This is minor, but I feel this section might read more fluidly if these "read more" lines were moved next to the If you want do debate this further paragraph, so that the reader goes through:
- Context (
From the author's mouth...) - "Flaws" in existing systems (
many "actor systems"...) - What
tractorbrings to the table (tractoraims to...) - Further reading and discussion (`If you want do debate...)
What do you think?
Yah 😎, it needs a bit more tweaking and possibly a PR into the theme to get it exactly where I'd like it but it's much closer to what i've been imagining. I will for sure address your quiffs with the actors rant section 😂 |
|
Think I'm just gonna land this and get a feel for this new docs theme going.. |
README bump for #210 as well a new docs theme which still has some stuff to work through (re: #157 (comment)).
I'd like to get our docs looking super polished before next release with a proper tutorial set as per #157.
Please feel free to (in particular) criticize the heck out of the readme update.