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

Content tweaks #16

Open
12 of 16 tasks
jl-n opened this issue Sep 8, 2016 · 4 comments
Open
12 of 16 tasks

Content tweaks #16

jl-n opened this issue Sep 8, 2016 · 4 comments

Comments

@jl-n
Copy link
Collaborator

jl-n commented Sep 8, 2016

A list of tweaks and corrections for the content, please add more if you encounter any.

General

  • @marktani Make it clear that checking out into another branch requires you to paste in the graphQL endpoints
  • @julianbauer Differentiate the theory and implementations section
  • @julianbauer Maybe distinguish between links and other text
  • @JulianTapales More photos of what the end of each step looks like
  • @julianbauer Some parts of the code are cut of like in "what-is-a-connection": viewer.allPokemons.edges.map((edge) => edge.node).map((pokemon) => console.log(pokemo
  • @julianbauer multiline code elements are intented by one space in the first line
  • @marktani link to the hosted demo application on overview/intro
  • @marktani put more focus on the LearnGraphQL project and less focus on the author of it. Maybe we should even include a screenshot of it?
  • @marktani Maybe include a section for explaining how to use the dashboard to test out queries or construct their own?

Queries

all @marktani

  • Add react-relay import into the tutorial
  • ViewerQueries is not exposed to ListPage as mentioned in tutorial
  • Taking a sneak peak at the solutions needs further instructions, currently people have been told to use git -f which loses their changes so maybe tell them to commit or stash? Additionally they would need to paste their graphcool url again in package.json and index.js before rerunning npm start
  • Maybe include and explain the {'Your viewer id is: ${this.props.viewer.id}'} in the tutorial section, so that as a rule, when a step is correctly finished, it looks identical to the solution
  • Feedback: "Unclear where to put export default Relay.createContainer"
  • Mention that the viewer property will also be most likely removed in Relay 2. I think a good general rule of thumb to put this informal information in > quotes.

Mutations

  • Feedback: "Where should I put the optimistic response answer? In the mutation??"
@marktani
Copy link
Member

marktani commented Sep 8, 2016

re: Differentiate the theory and implementations section

all the implementation sections are named Exercise XY. I think we can reach a good effect if we visually distinguish the implementation parts (i. e. a light-orange background or frame, or a certain icon that appears next to the section) @julianbauer, any ideas?

@marktani
Copy link
Member

marktani commented Sep 8, 2016

re: More photos of what the end of each step looks like

great idea! @JulianTapales, can you do that to make sure we have consistent video/image material of our app?

@jl-n
Copy link
Collaborator Author

jl-n commented Sep 8, 2016

@marktani Sure, no worries!

@julianbauer
Copy link
Collaborator

julianbauer commented Oct 19, 2016

whoh, @marktani sorry for the huge delay. That's how I would do it as well, my idea would be to have a 💪 Icon next to it. I think I'd go for a colored background as well. As soon as @schickling implements the differentiation in the markdown component, I'll make the change asap

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants