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.

Sign up for GitHub

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

Jump to bottom

Document contribution guidelines for API docs #3384

Merged
merged 1 commit into from
Oct 20, 2019
Merged

Document contribution guidelines for API docs #3384

merged 1 commit into from
Oct 20, 2019

Conversation

aldesantis
Copy link
Member

@aldesantis aldesantis commented Oct 17, 2019 •
edited
Loading

Description

Adds better contribution guidelines to solidus_api's README, to explain how to use Stoplight Studio to generate Stoplight Docs-compatible output.

Checklist:

  • I have followed Pull Request guidelines
  • I have added a detailed description into each commit message
  • I have updated Guides and README accordingly to this change (if needed)
  • I have added tests to cover this change (if needed)

@aldesantis
Document contribution guidelines for API docs
44266f2 
Because Stoplight Docs is not directly compatible with the output
from Stoplight Studio, there are some intermediate steps and
gotchas users need to be aware of when contributing to our API.
kennyadsl
kennyadsl approved these changes Oct 17, 2019
View reviewed changes
Copy link
Member

@kennyadsl kennyadsl left a comment

Choose a reason for hiding this comment

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

This is perfect @aldesantis, thanks!

spaghetticode
spaghetticode approved these changes Oct 17, 2019
View reviewed changes
Copy link
Member

@spaghetticode spaghetticode left a comment

Choose a reason for hiding this comment

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

@aldesantis thank you 👍

jacobherrington
jacobherrington approved these changes Oct 20, 2019
View reviewed changes
Copy link
Contributor

@jacobherrington jacobherrington left a comment

Choose a reason for hiding this comment

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

Thanks!

@jacobherrington jacobherrington merged commit 0d658a3 into solidusio:master Oct 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jacobherrington jacobherrington jacobherrington approved these changes

@JuanCrg90 JuanCrg90 JuanCrg90 approved these changes

@kennyadsl kennyadsl kennyadsl approved these changes

@spaghetticode spaghetticode spaghetticode approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@aldesantis @spaghetticode @kennyadsl @JuanCrg90 @jacobherrington