Skip to content

docs: ✏️ add more descriptive examples to getting-started.md#578

Merged
SanderElias merged 1 commit intoscullyio:masterfrom
donmckenna:docs-route-service
May 24, 2020
Merged

docs: ✏️ add more descriptive examples to getting-started.md#578
SanderElias merged 1 commit intoscullyio:masterfrom
donmckenna:docs-route-service

Conversation

@donmckenna
Copy link
Copy Markdown
Contributor

@donmckenna donmckenna commented May 24, 2020

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Other... Please describe: Adds more descriptive examples to Getting Started docs.

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.md now references the ScullyRoute interface, explains how its shape corresponds to .md blog post metadata, and how to include these additional arbitrary values in a template.

Does this PR introduce a breaking change?

  • Yes
  • No

Copy link
Copy Markdown
Contributor

@SanderElias SanderElias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks,

LGTM

@SanderElias SanderElias merged commit f8ab984 into scullyio:master May 24, 2020
@donmckenna donmckenna deleted the docs-route-service branch May 24, 2020 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants