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

Changed menu structure #4

Closed
christianalfoni opened this issue Feb 2, 2015 · 11 comments
Closed

Changed menu structure #4

christianalfoni opened this issue Feb 2, 2015 · 11 comments

Comments

@christianalfoni
Copy link
Contributor

Hi there,

You said that change of menu structure would probably break gitbook. I suggested a change now as it felt a bit weird to have those headers as links. There was not really anything to put in there :-)

It would be great, if you agree, to spread some fairy dust on gitbook and make this structure work.

Adding content whenever I get time. Things are starting to come a bit more together now. Looking forward to spreading it like crazy, I think this will be extremely valuable to developers :-)

@bebraw
Copy link
Member

bebraw commented Feb 2, 2015

I can make the structure work. There is one primary question, though. Gitbook works using section/subsection kind of structure. In the structure you are proposing we get subsections. The question is, what to put on the section pages?

One way to deal with it would be to set up a convention. Let's say each chapter (Webpack, React JS, ...) has a certain, named section at the beginning. We could call that an introduction. I would then use the content of that to construct the primary page of the section. After all, that's what its purpose is. It is about introducing the section to the reader.

To summarize you would get a transformation like this:

## React JS -> Becomes a section named "React JS"

* Introduction -> Section content (I'll pick the first one or we can use a convention)
* Configuring React JS -> Subsection (same for the rest within this list) 
* ...

@christianalfoni
Copy link
Contributor Author

Aha, I see, if we have to have an introduction I think we can just go back
to the previous structure and use a "head introduction" convention. Not
sure what to put there though... maybe summarize the important parts of the
sub section?

Okay, I suggest we just switch back to previous structure and create
"introductions" for each section that summarizes the important points of
the sub sections :-)

On Mon, Feb 2, 2015 at 8:40 AM, Juho Vepsäläinen notifications@github.com
wrote:

I can make the structure work. There is one primary question, though.
Gitbook works using section/subsection kind of structure. In the structure
you are proposing we get subsections. The question is, what to put on the
section pages?

One way to deal with it would be to set up a convention. Let's say each
chapter (Webpack, React JS, ...) has a certain, named section at the
beginning. We could call that an introduction. I would then use the content
of that to construct the primary page of the section. After all, that's
what its purpose is. It is about introducing the section to the reader.

To summarize you would get a transformation like this:

React JS -> Becomes a section named "React JS"

  • Introduction -> Section content (I'll pick the first one or we can use a convention)* Configuring React JS -> Subsection (same for the rest within this list) * ...


Reply to this email directly or view it on GitHub
https://github.com/christianalfoni/react-webpack-cookbook/issues/4#issuecomment-72416689
.

@bebraw
Copy link
Member

bebraw commented Feb 2, 2015

maybe summarize the important parts of the sub section?

It's the perfect place for some background information. So instead of having to start with technical stuff, it is possible to understand why this or that thing is important. It's mostly about providing the reader sufficient motivation to actually go through the material. I can help you to write these and provide initial stubs with some core ideas.

I'll change the structure back to previous and add little introductions for you to look at.

@christianalfoni
Copy link
Contributor Author

Fantastic, thanks :-)

On Mon, Feb 2, 2015 at 9:07 AM, Juho Vepsäläinen notifications@github.com
wrote:

maybe summarize the important parts of the sub section?

It's the perfect place for some background information. So instead of
having to start with technical stuff, it is possible to understand why this
or that thing is important. It's mostly about providing the reader
sufficient motivation to actually go through the material. I can help you
to write these and provide initial stubs with some core ideas.

I'll change the structure back to previous and add little introductions
for you to look at.


Reply to this email directly or view it on GitHub
https://github.com/christianalfoni/react-webpack-cookbook/issues/4#issuecomment-72419245
.

@bebraw
Copy link
Member

bebraw commented Feb 2, 2015

As promised, I expanded the introductions: React, Webpack.

I'm not sure what that CSS section is about. Can you expand on that?

How about Advanced? What would be the gist of that section?

@christianalfoni
Copy link
Contributor Author

Great!

Jup, will expand on CSS. Was thinking of explaining the css loader, style loader, less and imports in less. Fonts, image inlining etc. :-)

In advanced I was thinking of optimizing in general. React hot loader. Advanced might not be the right header... its like, not advanced, but more, "wing it like a pro" :-)

@bebraw
Copy link
Member

bebraw commented Feb 2, 2015

Jup, will expand on CSS. Was thinking of explaining the css loader, style loader, less and imports in less. Fonts, image inlining etc. :-)

Ok. Do you want to do an intro for that or should I write something? It would be a good idea to discuss the history and previous solutions a little bit like I did in mine to provide some context. The subsections can then build on this.

I like the idea of Wing It Like A Pro. Now the intent is more clear.

@christianalfoni
Copy link
Contributor Author

Hi, yeah, I saw your introductions. They are great! :-) I am having a hard
time making those introductions, so it would be great if you felt inspired
to write up one on CSS, fonts and images. I will continue to crunch in
details in the meantime.

On Mon, Feb 2, 2015 at 6:38 PM, Juho Vepsäläinen notifications@github.com
wrote:

Jup, will expand on CSS. Was thinking of explaining the css loader, style
loader, less and imports in less. Fonts, image inlining etc. :-)

Ok. Do you want to do an intro for that or should I write something? It
would be a good idea to discuss the history and previous solutions a little
bit like I did in mine to provide some context. The subsections can then
build on this.

I like the idea of Wing It Like A Pro. Now the intent is more clear.


Reply to this email directly or view it on GitHub
https://github.com/christianalfoni/react-webpack-cookbook/issues/4#issuecomment-72500522
.

@bebraw
Copy link
Member

bebraw commented Feb 4, 2015

@christianalfoni I expanded on that CSS, fonts and images introduction. I'm still a bit unsure on what to put to fonts/images parts but those parts will make more sense after I see what you write about them.

@christianalfoni
Copy link
Contributor Author

Awesome :-) Jup, I will continue with details on that stuff as soon as I get a chance

@bebraw
Copy link
Member

bebraw commented Feb 23, 2015

Exhausted this discussion. Better open separate issues as needed.

@bebraw bebraw closed this as completed Feb 23, 2015
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

No branches or pull requests

2 participants