Repository navigation
refactor: remove the source.placement option - #405
Merged
Merged
Conversation
The option was documented as choosing between the usage row and the title for the "source" link, but no version of Great Docs ever read it: the link has always rendered in the usage row. Drop it from the default configuration, the configuration guide and the config reference, along with the test package that existed only to exercise it. A `placement` key left in an existing configuration is ignored.
📚 Preview this PR's docs locallyFetch the just-built site and open it in your browser: # this exact build
great-docs preview --run 39794416426
# or always the latest build for this PR
great-docs preview --pr 405Auth & tips
|
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.
This PR removes the
source.placementoption. The configuration guide documented it as a choice between showing the source link in the usage row (usage, the default) or beside the object's title (title). However, setting it has never had any effect. Great Docs has always placed the link in the usage row, and no version ever read the setting.A
placementkey left in an existinggreat-docs.ymlis now ignored, so sites that set it build exactly as before. The test package that existed only to exercise the option is gone too.