Skip to content

Commit

Permalink
docs: flow corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
Novout committed Nov 13, 2022
1 parent a1b705b commit 0bf2358
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 6 deletions.
Binary file added .github/reactivitysave.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/themebase.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/ENTITY_MODEL.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ To more easily deal with the issue of data entry (mainly keyboard related) it wa

> The AST itself was built only in version v3, as the editor has already gone through other ways of working before arriving at this solution.
### Reactivity

All context (both mutable and global file access) is handled directly by [pinia stores](https://pinia.vuejs.org/). Therefore, we were able to deliver a fully reactive and instant application to users' perception.

For this, it was necessary to work around some limitations, such as saving changes only when the context is blurred ([not using vue's native `v-model`](https://github.com/Novout/betterwrite/blob/main/packages/better-write-app/src/use/block/text.ts#L49)).

![Reactivity Save](../.github/reactivitysave.png)

> Because of this alternative, some items in the editor will not directly show the interface, being mutated only when the given emitter event is.
### Annotations Editor

The annotations do not use the proprietary editor because its purpose is different from the primary focus, which made it necessary to integrate an editor that allows a different way of dealing with the necessary resources.
Expand Down
2 changes: 2 additions & 0 deletions docs/MULTITHEME.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ The multi-theme plugin was built given the choice of architecture focused on cus

> By default, the chosen initial theme depends on the system presets (undefined, white or dark).
![Theme Flow](../.github/themebase.png)

### WindiCSS

Migrating from [Tailwind](https://tailwindcss.com/) to [WindiCSS](https://windicss.org/), this choice was essential to facilitate the relationship between the values ​​inserted by the theme with the semantics of the inserted classes, where each `.vue` component (or at least most of them) has its own keys for each coloring item.
Expand Down
6 changes: 0 additions & 6 deletions docs/PROJECT_FLOW.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

To provide a better experience with the projects and follow the Offline First precepts, the project is based on a `.json` divided into usage and access categories. With this, it is possible to adapt the entire context solely on the Client-Side and offer a range of tools that do not depend on internet access or an overloaded server.

## Reactivity

All context (both mutable and global file access) is handled directly by [pinia stores](https://pinia.vuejs.org/). Therefore, we were able to deliver a fully reactive and instant application to users' perception.

For this, it was necessary to work around some limitations, such as saving changes only when the context is blurred ([not using vue's native `v-model`](https://github.com/Novout/betterwrite/blob/main/packages/better-write-app/src/use/block/text.ts#L49)) and basing modal changes only when they are closed.

## JSON Structure

The `.json` consists of:
Expand Down

0 comments on commit 0bf2358

Please sign in to comment.