Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation outdated? #27

Open
warpdesign opened this issue Oct 24, 2024 · 2 comments
Open

Documentation outdated? #27

warpdesign opened this issue Oct 24, 2024 · 2 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@warpdesign
Copy link

warpdesign commented Oct 24, 2024

The repository README.md as well as the website appear to be outdated:

The steps object example should be:

[
  {
    tour: "firstyour",
      steps: [
        Step
      ]
  },
  {
    tour: "secondtour",
      steps: [
        Step
      ]
   }
]

instead of:

{
  tour: "firstyour",
  steps: [
    Step
  ],
  tour: "secondtour",
  steps: [
    Step
  ]
}
@imkebe
Copy link

imkebe commented Oct 31, 2024

I can confirm. It appears the array is an expected input with the tour object.

@uixmat
Copy link
Owner

uixmat commented Dec 22, 2024

Thanks for finding the issue @warpdesign and confirming @imkebe - I'm making some updates to documentation at the moment!

@uixmat uixmat self-assigned this Dec 22, 2024
@uixmat uixmat added bug Something isn't working documentation Improvements or additions to documentation labels Dec 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants