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

gitbooks not showing link for "Core concepts" #482

Merged
merged 6 commits into from
Aug 5, 2017
Merged

Conversation

thewhitetulip
Copy link
Contributor

While reading the online book there is no link for next chapter after the Getting started one because Core concepts has no file attached to it.

While reading the online book there is no link for next chapter after the Getting started one because Core concepts has no file attached to it.
@ktsn
Copy link
Member

ktsn commented Nov 25, 2016

It seems like there is still not exist the link though.

@thewhitetulip
Copy link
Contributor Author

@ktsn I am really sorry I didn't understand what your comment meant.

@ktsn
Copy link
Member

ktsn commented Nov 25, 2016

there is no link for next chapter after the Getting started

I mean that this situation persists when I check the docs with your patch in local.

@thewhitetulip
Copy link
Contributor Author

Did the gitbook's build fail? I can't really find the root cause of this not working without seeing the output of gitbooks. Do you have gitbooks installed on local?

@ktsn
Copy link
Member

ktsn commented Nov 26, 2016

The build succeeded but there is still no link for next page in the Getting Started page. Or you just intended to add the link at "Core Concept" in ToC?

@thewhitetulip
Copy link
Contributor Author

Well, I am not sure what I did :-)

So let me pinpoint the problem so you can fix it.

When I am reading the gitbooks book, I don't have a (next) button for every page except http:https://vuex.vuejs.org/en/getting-started.html has a next button. This is because the next section has no link, thus no next.

@ktsn
Copy link
Member

ktsn commented Nov 27, 2016

OK, I found the cause. We should update SUMMARY.md to available the next button in Getting Started.
But if we do so, the next button in State chapter is not working. I guess it is because the link for state.md is duplicated on ToC.
Do you have any ideas to solve this? I'm actually not familiar with gitbook :)

@thewhitetulip
Copy link
Contributor Author

Yes, you are right. I have used gitbooks earlier once, https://github.com/thewhitetulip/web-dev-golang-anti-textbook/blob/master/SUMMARY.md

What I had done to mitigate this issue is add a new file for the one not showing the link, like a landing page. Can we do the same? Or what we can do is, shift the state one level up and link to it in Core Concepts itself.

Do let me know what you wish to do. We can close this issue and start a new one.

@ktsn
Copy link
Member

ktsn commented Nov 27, 2016

Thanks for suggesting your solutions.

add a new file for the one not showing the link, like a landing page

I'm not sure if I understand you correctly but do you mean adding core-concepts.md that including links for child chapters (State, Getters, etc.)?
If so, I think it would be the best idea. 🙂

@thewhitetulip
Copy link
Contributor Author

Yes, we can add a new core-concepts.md which will just say something like , " In this section we will study the core components". with a link to the child chapters :-)

@ktsn
Copy link
Member

ktsn commented Nov 29, 2016

Great! Can we add it on this PR?

@thewhitetulip
Copy link
Contributor Author

Done! @ktsn Please check.

- Getters
- Mutations
- Actions
- Modules
Copy link
Member

Choose a reason for hiding this comment

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

It would be great if these items have the link to the corresponding chapter 🙂

@@ -7,7 +7,7 @@
- [Installation](installation.md)
- [What is Vuex?](intro.md)
- [Getting Started](getting-started.md)
- Core Concepts
- [Core Concepts](state.md)
Copy link
Member

Choose a reason for hiding this comment

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

Can we also update this link to core-concepts.md?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, sorry. I had intended it to have core-concepts.md link only. Somehow missed it.

@@ -0,0 +1,10 @@
# Core concepts
Copy link
Member

Choose a reason for hiding this comment

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

It's a trivial thing but camelizing all words is better like other chapter title.
Core Concepts

@thewhitetulip
Copy link
Contributor Author

👍 Done

@ktsn
Copy link
Member

ktsn commented Nov 29, 2016

Thanks! LGTM 🙂
/ping @yyx990803

@thewhitetulip
Copy link
Contributor Author

I had to search for what LGTM meant. 😄

@ktsn ktsn added the documentation Improvements or additions to documentation label Apr 18, 2017
@michalsnik
Copy link
Member

michalsnik commented Aug 4, 2017

Hey @ktsn , is there a reason it's not merged yet? Are you waiting for @yyx990803 approval?

@thewhitetulip there is a conflict, could you please update this PR?

@ktsn ktsn merged commit 5257afe into vuejs:dev Aug 5, 2017
@ktsn
Copy link
Member

ktsn commented Aug 5, 2017

Sorry for leaving this for a long time. This look great, thank you!

@thewhitetulip
Copy link
Contributor Author

Finally!

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

Successfully merging this pull request may close these issues.

None yet

3 participants