Git Product home page Git Product logo

Comments (11)

bebraw avatar bebraw commented on May 18, 2024

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) 
* ...

from webpack-book.

christianalfoni avatar christianalfoni commented on May 18, 2024

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 [email protected]
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
.

from webpack-book.

bebraw avatar bebraw commented on May 18, 2024

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.

from webpack-book.

christianalfoni avatar christianalfoni commented on May 18, 2024

Fantastic, thanks :-)

On Mon, Feb 2, 2015 at 9:07 AM, Juho Vepsäläinen [email protected]
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
.

from webpack-book.

bebraw avatar bebraw commented on May 18, 2024

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?

from webpack-book.

christianalfoni avatar christianalfoni commented on May 18, 2024

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" :-)

from webpack-book.

bebraw avatar bebraw commented on May 18, 2024

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.

from webpack-book.

christianalfoni avatar christianalfoni commented on May 18, 2024

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 [email protected]
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
.

from webpack-book.

bebraw avatar bebraw commented on May 18, 2024

@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.

from webpack-book.

christianalfoni avatar christianalfoni commented on May 18, 2024

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

from webpack-book.

bebraw avatar bebraw commented on May 18, 2024

Exhausted this discussion. Better open separate issues as needed.

from webpack-book.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.