Grok 4 Noobs is, as previously mentioned, a site which documents itself.  This documentation is a narrative - it tells a story -  and does not always discuss API's in detail. There are rather a lot of API and other documents available on the web, to which we will refer as needed.  By doing this we hope to add some value rather than detract from what is already abundantly available.

The full source for this site is available on GitHub, and licensed under the GPL v2.  Installation instructions are included, and the best way to use this site is in conjunction with the source.

This site makes use of the prince utility if available to convert itself into a printable booklet.  You can access this by clicking on the "Make Book" button if it is shown; if prince is not installed, the button will not show.

There is a prescribed norm for writing tutorial or descriptive documents. The idea is to start with small easily understood building blocks and work your way up to eventually implementing a small site or product. Common wisdom is that by introducing concepts first, one can build upon existing knowlege almost like building a tower, eventually introducing more meaty material.

One problem with this approach is that it is often tedious and it is very easy to lose sight of big picture concepts.  By definition, one is expected to understand the sum of preceding pages completely in order to understand this shiny new concept presented at the end.  This cumulative cognitive overload can become an inhibitor to learning.  While noobs might find it fascinating, advanced audiences merely find it boring, and in theory, all noobs may advance.

In the case of the documentation presented here, the idea is to describe and present a fully formed concept, and then discuss the detail as necessary.  Show people the tower, and then discuss how the beams rest on and support one another, how useful the struts are, or how windows make the most of the sunlight.

So, for example, we will present a functional module, explain what it is supposed to accomplish, and then dig down while there is still information to impart.  One might refer to this as a top-down rather than the traditional bottom-up approach to writing documents.

The narrative style of this document is closer to what may be found in a book than a web site.  Each section (or chapter) may be quite lengthy, and discusses the detailed implementation for modules that make up this site.

Grok 4 Noobs

Designing a site, defining it's layout and implementing the code