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

[WIP] Pre-pre drafts for Getting Started and Interactors parts of documentation #661

Closed
wants to merge 1 commit into from

Conversation

minkimcello
Copy link
Contributor

Motivation

To get some inspiration on how we should approach our docs, I reviewed Gatsby, MSW, Redux, React, Ember, and Cypress's websites, and I came to the conclusion that it should be catered to the tool/framework itself.

The principle I'm trying to follow is that a good doc should read like a book and users should be able to read from top to bottom and get a good understanding of BigTest without having to hop back and forth.

Approach

Without adding actual pages, I just added markdown files in directories to help visualize what our dropdown menu should look like. Click on the links of the tree below to see what I wrote so far:

  • Getting Started
  • Guides
    • Interactors
    • Development Workflow
      • bigtest server vs bigtest test vs bigtest ci
      • Setting up CI
        • Github Actions
        • CircleCI
    • Configure Browsers
      • webdriver caveats
      • multi-browser parallel testing
    • iOS and Android Simulators
    • Setup Code Coverage
  • Concepts
    • Test Tree
    • Steps and Assertions
      • Grouping syntax
      • Describe how steps always run before assertions
      • Declarative tests as @jorgelainfiesta mentioned. This section can be linked to earlier in the guides so when people are reading about interactors and thinking "okay, how do I write assertions or steps without interactors?"
  • API
  • Stubbing API

@changeset-bot
Copy link

changeset-bot bot commented Oct 29, 2020

⚠️ No Changeset found

Latest commit: 1421b71

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

📣 NOTIFICATION

You are receiving this message because we did not publish any packages.

Generated by 🚫 dangerJS against 1421b71

@minkimcello
Copy link
Contributor Author

Closing because of #662

@minkimcello minkimcello closed this Nov 3, 2020
@minkimcello minkimcello deleted the mk/docs branch February 3, 2021 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant