docs: ✏️ add more descriptive examples to getting-started.md#578
Merged
SanderElias merged 1 commit intoscullyio:masterfrom May 24, 2020
donmckenna:docs-route-service
Merged
docs: ✏️ add more descriptive examples to getting-started.md#578SanderElias merged 1 commit intoscullyio:masterfrom donmckenna:docs-route-service
SanderElias merged 1 commit intoscullyio:masterfrom
donmckenna:docs-route-service
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: #501
The current Getting Started docs are a bit vague on where Scully gets the data for
ScullyRouteService.available$and how to add additional values to that data.What is the new behavior?
getting-started.mdnow references theScullyRouteinterface, explains how its shape corresponds to.mdblog post metadata, and how to include these additional arbitrary values in a template.Does this PR introduce a breaking change?