-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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.
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
feat(gatsby-transformer-documentationjs): support linking typedefs #11597
Merged
Conversation
This file contains 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
pieh
added
status: WIP
breaking change
If implemented, this proposed work would break functionality for older versions of Gatsby
labels
Feb 6, 2019
pieh
force-pushed
the
documentation-js-typedefs
branch
from
February 25, 2019 20:41
198e531
to
9bb763b
Compare
3 tasks
pieh
changed the title
feat(gatsby-transformer-documentationjs): support linking typedefs [wip]
feat(gatsby-transformer-documentationjs): support linking typedefs
Feb 26, 2019
pieh
added a commit
that referenced
this pull request
Mar 13, 2019
This includes changes from #11597 which is needed for nested and also some really unrelated changes (to make preview work on netlify). Actual changes for review are limited to pieh/gatsby@58c6855...pieh:www-doc-preview .org preview available at https://www-doc-preview--tender-curie-facda8.netlify.com/docs/node-api-helpers/ TO-DO before the merge: - [x] change new path to `/docs/node-api-helpers` (from `/docs/node-apis-helpers`) - [x] remove temporary commit that allow to build previews on netlify ( 58c6855 ) - [x] merge #11597 and remove commits from that PR from this branch Closes #4120
This was referenced May 25, 2021
Open
This was referenced Sep 16, 2021
Open
This was referenced Dec 1, 2021
This was referenced Jun 24, 2023
This was referenced Nov 28, 2023
This was referenced Jan 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
breaking change
If implemented, this proposed work would break functionality for older versions of Gatsby
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.
There is some breaking changes here so will require major version bump
Added features:
for example
type
information making it much harder to use nicelythis PR sets
optional
field (true/false) in documentation nodes and moves type information up to not have to handle this in frontend codethis is BREAKING CHANGE
@deprecated
fieldparams
,properties
andreturns
fields get transformed into separateDocumentationJS
nodes - those fields contain subset ofDocumentationJS
fields, but it's super nice for defining reusable fragments for types (and typedefs)this is BREAKING CHANGE if someone was using fragments for those fields - but this might be unlikely anyone actually did because GraphQL type name was generated dynamically during schema inference so it might change between builds, if fragments weren't used there is no need to change anything (i.e. our queries on
www
don't require any changes)TODO: bump
documentation
package version - we are 2 major versions behind latest - from their changelog it doesn't seem like there are any breaking changes that would affect us, but need to validate that