Skip to content
This repository has been archived by the owner on May 4, 2022. It is now read-only.

Preconfigured "Dekk" in "getting started" is confusing #31

Open
TimPietrusky opened this issue Mar 3, 2018 · 2 comments
Open

Preconfigured "Dekk" in "getting started" is confusing #31

TimPietrusky opened this issue Mar 3, 2018 · 2 comments

Comments

@TimPietrusky
Copy link
Member

Issue description

It's confusing for me that the preconfigured Dekk is called Dekk. Don't get me wrong: I love that there is a default component to use without having to touch everything else. BUT when I want to change something, it gets confusing, because after the "getting started" you use the dekk/deck component.

I'm not sure how to address this issue. Maybe rename the preconfigured Dekk into PreconfiguredDeck? So that it's clear that this is the base to get started?

Steps to reproduce

  • Open the getting started and create your App based on the steps
  • Open anything else from the documentation

Versions

  1. dekk: 1.0.0-17
@pixelass
Copy link
Member

pixelass commented Mar 5, 2018

I hear you.

We won't change this, but I can why this is confusing. Right now naming is less of a concern but we might use a different name in the guide:

import DekkApp, {Slide} from '@dekk/dekk'

export default (
  <DekkApp>
    <Slide>1</Slide>
  </DekkApp>
)

To help you understand:

Dekk is the name of the library. Deck is a module used to build your Dekk.
There are different versions Deck, SpeakerDeck which are handled inside Dekk/DekkApp so you don't have to. This feature was mainly added to make it easier to get started so it could be considered experimental right now.

@TimPietrusky
Copy link
Member Author

Sounds super ❤️ to me!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants