Repository navigation
Overhaul the doc site - #116
Merged
Merged
Conversation
The Schema tab now accepts SDL as well as an introspection result, pasted or uploaded as a file, and detects which one it got from the content. Also pass the selected enum strategy on the schema path (it was hardcoded to FailIfMissing), and replace TabBlazor's Dimmer with Tabler's dimmer markup so toggling the loading state no longer resets the active tab.
Replace the home page, which was a copy of the README's reference material, with an introduction: what Linq2GraphQL is, a first query next to the GraphQL it sends, how it works, features and packages. Move the rest into a Getting Started page and a Generator reference page, which also fixes the option list (typos, missing --schema and --agent) and the dependency injection example (the method is Add<Client>). Remove the Samples section and Monaco. The interface sample used a node id the Star Wars API no longer accepts and crashed the app, and the others only ran behind an unlabelled expand icon. Upgrade TabBlazor from 0.8.1.1-alpha to 1.6.7-beta, with Tabler CSS 1.4.0 and AddTabBlazor.
A common misunderstanding is that Linq2GraphQL always fetches whole objects. Projecting in Select requests only the fields the projection reads, at any depth. Show that with four examples, each with the GraphQL it sends and the result, and add a short section to the home page that links to it.
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.
Reworks the documentation site (linq2graphql.com).
Online generator
FailIfMissing).Dimmerrebuilds its children, so it is replaced with Tabler's dimmer markup).New pages
Selectfetches only the fields the projection reads; four examples with the GraphQL and results.--schemaand--agent) and the DI example (Add<Client>, not<Client>).All examples were run against the Star Wars API; the GraphQL shown is what they actually send.
Removed
Upgraded
AddTabler→AddTabBlazor.docs/is outside the CI solution filter, so CI does not build these changes; the site was built and checked in the browser.