Improvements to API Reference #830
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
Standing this up for feeback. While it does have pretty obvious UX disadvantages, it draws a clearer distinction and provides more detail in the docs. * Promote API link to header menu * Serve HTML API docs out of public dir - if we stick to this we'll want to clean up the URLs with Next redirects or something similar.
See /api/classes/NextDrupal.html#getresource for output
Not positive if we want to ignore this, or just find a way to re-order this in menus.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
backlineint
commented
Jan 21, 2025
| @@ -294,6 +294,62 @@ export class NextDrupal extends NextDrupalBase { | |||
| * @param {string} uuid The UUID of the resource. | |||
| * @param {JsonApiOptions & JsonApiWithCacheOptions & JsonApiWithNextFetchOptions} options Options for the request. | |||
| * @returns {Promise<T>} The fetched resource. | |||
| * @examples | |||
There was a problem hiding this comment.
This examples diff was made by feeding the markdown from the old reference section to Copilot, which made this waaaay less tedious.
There was a problem hiding this comment.
Nice! This looks really good.
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 pull request is for: (mark with an "x")
examples/*modules/nextpackages/next-drupalstarters/basic-starterstarters/graphql-starterstarters/pages-starterGitHub Issue: #829
Please add a link to the GitHub issue
where this problem is discussed.
Describe your changes
More detail in the issue, but this PR is attempting to bridge the gap between our old API reference section and the new autogenerated API docs.
This would also be a reasonable home for any final documentation updates related to the 2.x stable release.