TheGame icon indicating copy to clipboard operation
TheGame copied to clipboard

Playbooks

Open peth-yursick opened this issue 3 years ago • 12 comments

Playbooks are short onboarding & skill-building guides. Right now they are hosted on the wiki but we need to build them a proper interface to make it easier for people to submit them as well as upvote/downvote them, filter them, etc.

The design should be based on the existing MetaGame branding & some of this design already exists for Playbooks as well.

The design still needs to be finished & help is required but we mainly need help with building. You can find the links to everything you'll need to get familiar with the codebase here, you can ask for help here or contact me @petheth on twitter or telegram.

Useful things to get built:

  • Playbook posting itself
  • Categories & filtering
  • Upvoting/downvoting playbooks
  • Time to read
  • Reacting to playbooks
  • Comment
  • Share
  • Fork
  • Bookmark (pin to your "dashboard" or "goals" both of which are nonexistant features)

We realize this is far from being specced out & requires more than 2 people, but if you're interested in jumping on this, do know there are others ready to jump in & help as well. If you're interested in working on this, just comment here or ask about it on discord.

More links: Playbooks Spec WIP More info on the whole Playbooks project Playbook WIPs on Notion 📕-playbooks discussion on Discord Playbooks UI WIP

peth-yursick avatar Jun 28 '21 12:06 peth-yursick

Additional features maybe - Voice Narration & Gated Content (NFTs or SEEDs) Categories: DAOs, DeFi, NFTs & dApps

Any other categories, are we going to purely crypto focused?

If we could also add notification, if you Follow a particular playbook author.

Thoughts?

FearlessThompson avatar Jul 04 '21 16:07 FearlessThompson

This is awesome. Thank you @FearlessThompson and @peth-yursick. We now have enough ideas to start planning 👍 The method I'd propose is user story mapping.

But before we got to that, it would be ideal if we could get a builder to work on it with us. Hopefully this person will also know what's possible with the new platform that will be underpinning the Wiki (Docusaurus?), and thus the Playbooks UI. All in the interest of keeping us as efficient as possible.

IIRC, that person might be @jonathanprozzi (?)

davort avatar Jul 04 '21 21:07 davort

No worries! Understood that would be ideal, I've been meaning to reach out to @jonathanprozzi too. He's been assigned, so hopefully we can get this going.

How would we like to approach the User Story Mapping,I was thinking of maybe a Follow Author feature on Iteration 3.

Depending on availability, would the 3 of us need a quick meeting to discuss the next steps? Yourself & @jonathanprozzi this week?

FearlessThompson avatar Jul 07 '21 09:07 FearlessThompson

Still digging in to this, but a few of the lighter lifts can be integrated right now (such as the reading time) -- will keep exploring and will ask any questions!

jonathanprozzi avatar Jul 07 '21 18:07 jonathanprozzi

@FearlessThompson - ideally, we'd know all that is, and isn't possible. But even if we don't know (yet), we can still plan, just somewhat more conservatively. Even then, we could plan for a solid first release, which would be way better from what we've had thus far.

Follow Author - great idea, keep them coming! 😊

@jonathanprozzi - thanks for the update on the "reading time". It will be a great feature to have in the first release! Please keep us posted when you learn any new info. I'd for one would be very interested in knowing whether we can enable people to "add books to a reading list", make bookmarks, add notes, etc. Just as an idea.

davort avatar Jul 07 '21 19:07 davort

Playbooks UI - User Story Mapping session

@FearlessThompson and I met with @luxumbra and @jonathanprozzi yesterday, to take a stab at making a plan for building the Playbooks UI.

We used User Story Mapping as our method of choice, because it let us put all our thoughts onto the FigJam board, which allowed us to make room in our minds for even better ideas :slight_smile: Once on the FigJam board, we could take a look at these ideas, and establish what we did, and didn't know, was feasible or even possible.

CleanShot 2021-07-09 at 21 26 15

This led us to making following conclusions:

  1. The initial idea was to make the Playbooks UI a part of the revamped Wiki, which will be built with Docusaurus. The more we were thinking about how to make a truly useful UI for enjoying Playbooks, the more it became clear that many of the features would rely on the ability for players to be logged into the system, which Docusaurus isn't really meant to support out-of-the-box. Hence, the first/interim release will most likely still run as part of Wiki, but it will be limited in features, because of Docusaurus' limitations.
  2. The second, and all subsequent releases, will most likely have to be built as a part of MyMeta. The Quests UI, which itself is still pending finalisation, seems to offer a good foundation for the future Playbooks UI. This is the idea that we need to work on more thoroughly moving forward. The idea is appealing, since it would allow us to reuse something we've already built. Thus, we'd save time, and maintain a coherent UX :raised_hands:
  3. There are a few open questions, such as how do we deal with categories, tags, etc.? @FearlessThompson is on top of that one.

We'll meet again after the weekend, with new findings, so that we can hopefully lock in the initial release. The result of this will be a list of features to consider while designing the UI.

Any questions about any of this, please let me know.

davort avatar Jul 09 '21 19:07 davort

Here's the first batch of mobile wireframes. The goal was to nail down the basic layout for mobile, while making sure all is accessible in terms of sizes for tap target areas, font-sizes and colors.

The mockups are showing:

  1. Landing page view → a sort of a digest, showing the latest—or most read?—additions to each category
  2. Landing page w/ category hidden/collapsed → just an idea for keeping mobile view shorter and easier to scroll, in case the user isn't interested in certain categories
  3. Category view
  4. Article view
  5. Author view → should we add a 2-3 line long "bio" underneath the username?

CleanShot 2021-07-21 at 09 57 34

Eager to hear any and all of your comments or questions!

cc @FearlessThompson @luxumbra @jonathanprozzi @mquellhorst

davort avatar Jul 21 '21 07:07 davort

Loving the progress on this. Apologies for the slow response @davort

  1. Landing page view → a sort of a digest, showing the latest—or most read?—additions to each category

Great idea @davort 👍🏻 Sort by latest or most read would be nice.

  1. Landing page w/ category hidden/collapsed → just an idea for keeping mobile view shorter and easier to scroll, in case the user isn't interested in certain categories

Nice. maybe show the top/newest post and a 'view more books' to expand.

  1. Category view

No comment. 👍🏻

  1. Article view

No comment 💪🏻

  1. Author view → should we add a 2-3 line long "bio" underneath the username?

Yes, I think a short bio would be great. or link to their mymeta profile.

luxumbra avatar Jul 27 '21 16:07 luxumbra

My understanding was that this UI design was for My Meta/Meta OS. Is this the case, or are we designing it for the wiki?

Baconaetor avatar Aug 10 '21 03:08 Baconaetor

My understanding was that this UI design was for My Meta/Meta OS.

This is correct. You can find more context in the Playbooks UI Notion page.

davort avatar Aug 10 '21 05:08 davort

Ok, is there a way to move this issue to over there then?

Baconaetor avatar Aug 13 '21 04:08 Baconaetor

At Peth's request, I'm attempting to lay out a path towards an MVP for adding playbooks to the existing codebase (commonly known as MyMeta).

This seems to include, at the least:

Backend:

  • Defining new schema / tables to be added to Hasura / Postgres (Can be mostly inferred from here)
    • This can include additional metadata not necessarily in scope for the MVP as it's easiest to define as much of the schema as possible up-front
    • Consider permissions in Hasura, e.g. only the author can edit their own playbook
      • Playbooks are world-readable

Web:

  • Pick a rich-text editor / display component that is sufficiently advanced to accommodate all the content we want to include in Playbooks (we can probably just start with what Docusaurus etc supports)
    • Probably needs some flexibility with import / export in different data structures
    • How is the content data stored? Is it just exported as JSON, markdown, HTML etc? What about images? Can we just stuff the content in a database BLOB column or the like? Do we want to associate the content with the creator somehow via e.g ceramic?
  • Create / edit interface. This is essentially just the rich-text editor with a save button, plus additional fields for e.g. category selection, title, isPublished, cover image.
    • Authors must have a mymeta profile and be "signed in"
    • Probably sufficient to support this for large devices only .. ?
  • View playbook interface
    • Could be built-in to the rich-text component as a different "view"
    • Are there designs for this? I suppose it's somewhat dependent on the chosen rich-text component
  • List / filter playbook interface
    • Seems like there are designs for this already
    • Probably sufficient to just support listing all playbooks for the time being, only need e.g. filtering when there's so much content that it's not easily discoverable
  • "Time to read" is presumably just calculated based on word count or the like and can be re-computed on save in the backend

After writing this all out, it seems like choosing the rich-text editor / viewer is step #1, with possibly the DB schema definition happening in parallel.

alalonde avatar Nov 04 '21 22:11 alalonde