Skip to content

docs: readme makeover #94

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 22 commits into from
Apr 17, 2023
Merged

Conversation

setchy
Copy link
Contributor

@setchy setchy commented Mar 12, 2023

Overhaul of the README structure.

Main changes proposed are

  • update links back to latest public graphql specification sections
  • split out how to use section. include netflix dgs configuration documentation
  • introduce @specifiedBy directive with link to specification
  • convert each custom scalar entry from lists to a table
  • add scalar definition with @specifiedBy where available. (note: I had to use html instead of markdown in order to have code blocks within the table)
  • reorder of scalar entries to more logically group them

@dondonz
Copy link
Member

dondonz commented Apr 12, 2023

Hello @setchy, thanks for the PR! The tables are much easier on the eyes

Could you resolve the merge conflicts please? Thanks!

@setchy
Copy link
Contributor Author

setchy commented Apr 12, 2023

Anytime @dondonz. Merge conflicts have been resolved

@dondonz
Copy link
Member

dondonz commented Apr 17, 2023

Awesome! I'll merge in. Thank you again!

@dondonz dondonz merged commit 23a6969 into graphql-java:master Apr 17, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants