collab guides - #27
Conversation
|
This is great. I think the overall structure is good, and I think these are good guides. I have some notes on specifics but I can wait until a later point for that? Regarding the overall strcture, I think that it makes sense to have a new Guides section that these belong to, rather than putting them in Collab. Our current categories are: Introduction Shuffle I think we should add: Guides For these guides. And then we'll also want separate Collab and Presence sections, structured like the Shuffle section, with Overview, Quick Start, and API Reference pages. |
|
Oh, right. And then my other thought is that we shouldn't use React hooks for the code snippets, I think. Out of context of a component, it's sort of confusing to read. We could build the code snippets around a component that renders a ProseMirror component instead (I am now understanding this is probably what your Slack message meant), but I'm increasingly feeling like maybe we should just have these docs not be React-specific, and instead have separate docs for integrating with React (and probably provide our own hooks for it) |
So that structure makes sense to me, but I kind of think these guides would be the Quick Start section. I usually think of the quick start being the minimal guide to get a hello world set up, and then you have docs for all the different features you can use. But both presence and collab are single feature, and I don't think we can remove anything from the guide while keeping the feature functional. Do you think we could trim it down for the quick start? |
|
I think the Quick Start can basically just be much terser. A quick walk through how to set up the config, without actually needing to walk through an implementation for each method. The idea is to give a sense of how to use the library and what it will look like, I think. |
* Use typedoc to generate API reference for shuffle * Fix generated links
…and for changing z-index) (#29) * Add a z-index attribute that auto-increments on every drag start * Update docs * Expose commands for resize and z-index update * Bump version
* Fix resizing to right * Ban console.log
* added reference docs for collab and presence * fixed typos * fixes * rebuilt reference docs * resolved issues * fixed formatting * regen and format docs
* Flesh out shuffle demo content * Handle inflation at pos 0 and select node on pointer down
2 participants
No description provided.