Refactor /docs into Concepts#3877
Conversation
gefjon
left a comment
There was a problem hiding this comment.
Not a thorough review yet, just a few thoughts. Structurally this looks great, thanks so much!
|
The current TypeScript reference documentation on views seems wrong, I was mirroring this over to the new Views documentation and there seems to be several bugs. I'll reach out early next week to get assistance on this if I don't solve it myself first. |
|
@JulienLavocat - I've added you to review the work I've done here for the menu, I needed another level for the menu and I've let my CSS skills atrophy. I've targeted specifically the second level menu to get something workable for now as exampled here: |
|
@gefjon @cloutiertyler - I wanted to provide a write-up of the changes to hopefully make this review as targeted as possible.
The one thing I'm uncertain about is |
docs/docs/00100-getting-started/00100-intro/00400-key-architecture.md
Outdated
Show resolved
Hide resolved
cloutiertyler
left a comment
There was a problem hiding this comment.
I left comments inline. I think this is an excellent first pass. I think once the comments are resolved this can merge. I took a look at the styling too by running it locally. We'll want @randyclockwork to take a pass at some point, but I think this is fine for now.
I would like to take a second pass at this where we really try to distill down the basic concepts and put them together towards the top of the document. As it stands I think the table of contents is a little verbose before getting to the core concepts:
I would love to see the table of contents look more like:
Intro
Getting Started
Quickstarts
Tutorials
Core Concepts
Databases # I think we modify this to include modules as a section
Tables
Functions
Subscriptions
AuthenticationWhere if you expand all the sections it would look like:
Intro
Getting Started
Quickstarts
React
Vue
HTML
Unity
Unreal
Godot
Rust
... etc
Tutorials
Chat App # With language selectors for all the languages
Blackholio (Unity)
Blackholio (Unreal)
Core Concepts
Databases
The Database Module
Developing databases
Building and publishing
Transactions & Atomicity # discussion about atomic transactions and what they are (could also go in Functions)
Automatic migrations # these could also go into an "Advanced usage section"
Incremental migrations # these could also go into an "Advanced usage section"
Functions
Overview
Reducers
Procedures
Views
Tables
Defining tables
Reading data
Writing data
Scheduled tables
Performance best practices
Advanced
System tables
Subscriptions
Subscribing to tables
Reducer callbacks # will become event tables
Advanced semantics # should perhaps be embedded in one of the above
Authentication
SpacetimeAuth
Clerk
Auth0
# ... etc
Other features
PostgreSQL compatibility We might at some point need deeper levels of nesting and will need UI design for that.
Also please remove the "old files" before merging.
Co-authored-by: Phoebe Goldman <phoebe@clockworklabs.io> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
… for a cheat sheet
- Removal of confusing Rust/C# module note - Added missing useReducer import - Moved PrettyMessages below users to fix a bug later in the tutorial - Updated PrettyMessages to have null safety if the user follows the module bindings they may have an error due to spacetime call send_message
…ture.md Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
Co-authored-by: Tyler Cloutier <cloutiertyler@users.noreply.github.com> Signed-off-by: Jason Larabie <jason@clockworklabs.io>
…h to ReducerContext doc
26f562a to
4006748
Compare
# Description of Changes With the refactor docs I had left the original module folder and mistakenly didn't remove it as requested as per Tyler's comment: #3877 (review): > Also please remove the "old files" before merging. # API and ABI breaking changes N/A # Expected complexity level and risk 1 # Testing Removal of documents there is no test to run Co-authored-by: Zeke Foppa <196249+bfops@users.noreply.github.com>

Description of Changes
Refactoring all sections to match a concept based approach to the docs.
Closes: #3840
API and ABI breaking changes
N/A
Expected complexity level and risk
1
Testing