[WIP] Pre-pre drafts for Getting Started and Interactors parts of documentation #661
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
To get some inspiration on how we should approach our docs, I reviewed
Gatsby
,MSW
,Redux
,React
,Ember
, andCypress
'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:
bigtest server
vsbigtest test
vsbigtest ci