Repository navigation
Simplify documentation guidelines and explain inline code - #43
Merged
Merged
Conversation
samuel-williams-shopify
marked this pull request as ready for review
September 27, 2026 21:29
samuel-williams-shopify
force-pushed
the
simplify-documentation-guidelines
branch
from
September 27, 2026 21:29
685191a to
04054c4
Compare
samuel-williams-shopify
deleted the
simplify-documentation-guidelines
branch
September 27, 2026 21:31
This branch was successfully deployed
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
1 participant
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.
Remove the Best Practices and Common Pitfalls requirements from the Documentation Guides structure and template, along with related checklist guidance. Document Markly’s language-prefixed inline code syntax (
ruby:followed immediately by a code span), including theObject.newexample, syntax highlighting, and links to definitions. Keep the generated context copy in sync.Validation:
git diff --checkpasses and the guide matches its context copy. Rendering verification was blocked by missing bundle dependencies and a local Ruby/Markly native-extension mismatch.