Project Abandoned
Warning! This project was really fun and a learned a lot, but it has now been abandoned. Feel free to rummage around here among the bones, but don't expect to find anything living here!
This is the home of Skel's official documentation. I've tried to arrange this in the form of a very short book whose story arc will guide you through the process of learning about Skel and how to use it. Because Skel is just an interface library, though, the entire story is about why the interfaces were designed the way they were and how they work together and communicate. To demonstrate these concepts, the book will of course bring us through the creation of a sample application, for which I'll use my own "official" implementations of the Skel interfaces. These implementations, however, are a footnote, and the real conceptual takeaway is how they relate to each other and how you can create components that relate in the same way.
At the end of the book is the all-important Appendix A: API Docs, which will include API docs for my specific implementations, followed by a less important but still significant Appendix B: Best Practices. Enjoy!
Table of Contents
Chapter 1: Conceptual Overview
- What is Skel?
- For whom was Skel built?
- Why was Skel built? What problems does it attempt to solve?
- How does Skel fit into the world?
Chapter 2: Skel's Pieces—A Bird's Eye View
- Overview of current interfaces
- How components fit together
Chapter 3: A Sample Application
- Official Implementations
- Installation and Setup
- Routing
- The data layer
- Libraries
- Internationalization
- Packaging and Publishing
Chapter 4: Theory, In-Depth
- Interfaces vs Classes
- More about the data layer
- The
Component
Interface
Chapter 5: Going Further
- Skel roadmap
- Extending Skel
- Contributing to Skel
- Future possibilities
Appendix A: The API Docs
- How to Use the API Docs
- Skel Header Package
- Skel Uri Package
- Skel Config Package
- Skel Component Package
- Skel Db Package
- Skel Cms Package
- Skel App Package
- Skel Routing Package
- Skel Http Foundation Package
Appendix B: Best Practices
- Libraries vs Applications
- The
Component
Interface - Dealing with Data
- Interface, Interface, Interface