Project: Structured documents with Light Client

Problem

If someone wants to insert formatted content into the application the only way is using the frontend. But that task is not easily automated. So having a programmer friendly interface allowing that would be nice

Solution

The current lightclient CLI abstracts the complexity of handling the low level protobufs and exposes some useful task to the user. We can make availiable the create-draft command so if the user wants to write something like this:

Title
  Authors data
#Abstract
  Abstract Text
#Introduction
 #Brief1
   Block1
   Block2
#Main Text
   [/home/user/image.jpg]

1. client.py document create-draft --title TITLE
Response:
ynXsc3KKAirRPuGuB3wShz

2. client.py document create-draft --append --id ynXsc3KKAirRPuGuB3wShz “Author's data”
Response
AA5wDop2

3. client.py document create-draft --append AA5wDop2 --id ynXsc3KKAirRPuGuB3wShz --heading “Abstract”
Response
trEI23pS

4. client.py document create-draft --append trEI23pS --id ynXsc3KKAirRPuGuB3wShz --parent trEI23pS “Abstract text”
Response
dt762gG

5. client.py document create-draft --append trEI23pS --id ynXsc3KKAirRPuGuB3wShz --heading “Introduction”
Response
f5DA3J8

6. client.py document create-draft --append f5DA3J8 --id ynXsc3KKAirRPuGuB3wShz --parent f5DA3J8 --heading “Brief1”
Response
Vlu3Pss

7. client.py document create-draft --append f5DA3J8 --id ynXsc3KKAirRPuGuB3wShz --parent Vlu3Pss “Block1”
Response
94TCaf4N

8. client.py document create-draft --append 94TCaf4N --id ynXsc3KKAirRPuGuB3wShz --parent Vlu3Pss “Block2”
Response
bvj3FstA

9. client.py document create-draft --append Vlu3Pss --id ynXsc3KKAirRPuGuB3wShz “Main Text”
Response
bvj3FstA

10. client.py document create-draft --append dfD6Hk41 --id ynXsc3KKAirRPuGuB3wShz --parent dfD6Hk41 --image “/home/user/image.jpg”

Response
78UJgD3f

Scope

1 week backend

Rabbit Holes

None

No Goes

Any block type diferent than paragraphs, headings or Images.

Only Drafts allowed. This is to force visually inspection (via frontend) before publishing

Containing:Problem

Published:7 mo. ago Monday, April 29th, 2024

Author:

z6Mkj6DM...xi8d4w8w

First Version

Open in Mintter app