Content
View differences
Updated by Hagen Mahnke 8 months ago
# Goal
Continue supporting Markdown as API format for long text while taking full advantage of BlockNote and Yjs data structures. We do this, so that we can maintain existing API capabilities when extending BlockNote usage to work packages, wiki, comments, and so on.
## Step 1
Formulate and answer questions that
\- block us from moving forward confidently with collaborative editing in BlockNote for documentsÂ
\- pertain to risks for future usage in work packages
Continuously share this knowledge.
### Expected outcomes
Document the questions, answers and the process for arriving at those answers.
This includes code used in trials and proof of concepts.
This knowledge is continuously shared with the communicator team and Wieland.
#### ### To-dos
* [x] Formulate questions
* [ ] Share with Wieland and the team to refine them and identify missing questions
* [ ] Decide how best to share knowledge
### Questions to answer
**How well can we convert from Markdown to Y.docs (binary) through BlockNote JSON and vice versa?**
Are there things that don’t work? What are they?
#### How can interactions with work package descriptions stored as Y.docs through the API work?
Work packages descriptions are accessible through the API, we assume that we need to offer equivalent capabilities when work package descriptions use Y.docs / BlockNote JSON.
This includes the question of how we should store the descriptions - as Y.doc binary, BlockNote JSON, markdown or a combination of those?
###
#### How do we migrate the existing documents?
## Step 2
Decide on an implemenation strategy.
## Step 3
Implement it.
#
Continue supporting Markdown as API format for long text while taking full advantage of BlockNote and Yjs data structures. We do this, so that we can maintain existing API capabilities when extending BlockNote usage to work packages, wiki, comments, and so on.
## Step 1
Formulate and answer questions that
\- block us from moving forward confidently with collaborative editing in BlockNote for documentsÂ
\- pertain to risks for future usage in work packages
Continuously share this knowledge.
### Expected outcomes
Document the questions, answers and the process for arriving at those answers.
This includes code used in trials and proof of concepts.
This knowledge is continuously shared with the communicator team and Wieland.
####
* [x] Formulate questions
* [ ] Share with Wieland and the team to refine them and identify missing questions
* [ ] Decide how best to share knowledge
### Questions to answer
**How well can we convert from Markdown to Y.docs (binary) through BlockNote JSON and vice versa?**
Are there things that don’t work? What are they?
#### How can interactions with work package descriptions stored as Y.docs through the API work?
Work packages descriptions are accessible through the API, we assume that we need to offer equivalent capabilities when work package descriptions use Y.docs / BlockNote JSON.
This includes the question of how we should store the descriptions - as Y.doc binary, BlockNote JSON, markdown or a combination of those?
###
#### How do we migrate the existing documents?
## Step 2
Decide on an implemenation strategy.
## Step 3
Implement it.
#