Skip to content
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

Introduction Improvements #569

Merged
merged 4 commits into from
Mar 4, 2019
Merged

Introduction Improvements #569

merged 4 commits into from
Mar 4, 2019

Conversation

mathewbyrne
Copy link
Contributor

@mathewbyrne mathewbyrne commented Mar 4, 2019

This aims to improve our introduction and README sections with the following changes:

  1. README.md and docs/content/introduction.md now have the same content.
  2. Moved Feature Comparison into the main side out of README.md
  3. Added and linked to some Contribution Guidelines

Currently README and introduction are maintained separately. I couldn't figure out a way to have them read the same source; GitHub MD has no include functionality, and hugo cannot read files outside of it's root directory (/docs).

They also use different link syntax (hugo uses <ref > shorttags) making them a little incompatible.

Maybe we could lint for this? It's always going to be a bit fuzzy though. Otherwise some compile step that writes both files from a single source?

Of course, git can track links. With this we are able to link README.md into the hugo content dir and munge it's contents there.


First take a look at the [Getting Started]({{< ref "getting-started.md" >}}) tutorial.
First work your way through the [Getting Started]({{< ref "getting-started.md" >}}) tutorial.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO there definitely another paragraph here that mentions something about looking at Resolvers, Type Mapping etc, in roughly the order we think it's important to further learn gqlgen concepts.

@mathewbyrne mathewbyrne merged commit f2d9c3f into next Mar 4, 2019
@vektah vektah deleted the improve-introduction branch March 4, 2019 05:37
cgxxv pushed a commit to cgxxv/gqlgen that referenced this pull request Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant