Create definitions documentation

[kernelkind]

Added docs/definitons.md to have a source of ground truth for Notedeck related definitions. @jb55 let me know your thoughts and if you have any revisions. This is going to help reduce the likelyhood of misunderstandings in the future

[jb55]

On Wed, Jun 26, 2024 at 02:10:47PM GMT, kernelkind wrote:

Closes: https://github.com/damus-io/notedeck/pull/270

docs/definitions.md | 50 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 docs/definitions.md

diff --git a/docs/definitions.md b/docs/definitions.md [..] + +## Deck +A deck presents an ordered collection of columns to the user. +Columns are presented from left to right in the order of the collection. +Each column takes up the full vertical height of the app. +Columns can be resized in the horizontal direction.

Not technically true, not sure if it will be true either. I think we will stick with automatic horizontal sizes for the forseeable future.

+The current deck takes up the whole surface area of the app, besides the side panel. +The deck has one account associated to it. +Each column in the deck has the following choice of accessing a keypair: it can use the deck's account, a different, (public only) keypair, or None. + +## Deck Configuration +A deck configuration is all of the deck's settings encoded into a parameterized replaceable event nostr note.

We can just call these an "addressable event" as thats what nostr devs are moving to anyways

[kernelkind]

Not technically true, not sure if it will be true either. I think we will stick with automatic horizontal sizes for the forseeable future.

Can you elaborate on this? Which part is untrue? If you could provide a more accurate description that would be great.

[jb55]

specifically :

Columns can be resized in the horizontal direction.

we don't have the technical ability to do that yet (manually at least)

[kernelkind]

specifically :

Columns can be resized in the horizontal direction.

we don't have the technical ability to do that yet (manually at least)

My intention for the definitions.md is to have a shared understanding of what the app should be, what we're working towards, not what it currently is.

Do we want columns to be able to resized in the horizontal direction? I like the impl tweetdeck has, where you have discrete column widths Narrow, Medium and Wide. Is this something we want to do too?

[jb55]

On Thu, Aug 22, 2024 at 05:38:47PM -0700, kernelkind wrote:

My intention for the definitions.md is to have a shared understanding of what the app should be, what we're working towards, not what it currently is.

Do we want columns to be able to resized in the horizontal direction? I like the impl tweetdeck has, where you have discrete column widths Narrow, Medium and Wide. Is this something we want to do too?

I was hoping it would be more like how tiling window managers work. just have them equal sizes with a minimum size.

I think having them resizable is not that useful, unless you can think of reasons otherwise.