smartprocure · vyrnix9582046173 · May 25, 2018 · May 25, 2018 · May 25, 2018 · May 25, 2018
diff --git a/README.md b/README.md
@@ -1,2 +1,4 @@
-# contexture-docs
-Documentation for Contexture
+# Contexture Documentation
+
+This is the complete documentation for [Contexture](https://github.com/smartprocure/contexture).
+
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -0,0 +1,49 @@
+# Table of contents
+
+* [Contexture Documentation](README.md)
+
+## About Contexture
+
+* [What Is Contexture](about-contexture/what-is-contexture.md)
+* [Glossary of Terms](about-contexture/glossary-of-terms.md)
+* [Map of Repos](about-contexture/map-of-repos.md)
+* [Brief History](about-contexture/brief-history.md)
+* [Alternatives & Benchmarks](about-contexture/alternatives-and-benchmarks.md)
+
+## Getting Started
+
+* [Project Setup](getting-started/project-setup.md)
+* [Your First Contexture Script](getting-started/your-first-contexture-script.md)
+* [Connecting to Elasticsearch & MongoDB](getting-started/connecting-to-elasticsearch-and-mongodb.md)
+* [Connecting to Other Databases](getting-started/connecting-to-other-databases.md)
+* [Simple Search Box](getting-started/simple-search-box.md)
+* [Your First Filter](getting-started/your-first-filter.md)
+* [Discovering The Database](getting-started/discovering-the-database.md)
+* [IMDB Index](getting-started/imdb-index.md)
+
+## Querying
+
+* [Contexture DSL](querying/contexture-dsl.md)
+
+## Types and Type Components
+
+* [DIY Types](types-and-type-components/diy-types.md)
+* [ElasticSearch Example Types](types-and-type-components/elasticsearch-example-types.md)
+* [MongoDB Example Types](types-and-type-components/mongodb-example-types.md)
+
+## Other Components
+
+* [Generally Useful Components](other-components/generally-useful-components.md)
+* [Layout Components](other-components/layout-components.md)
+
+## Under the Hood
+
+* [Design Principles](under-the-hood/design-principles.md)
+* [Contexture Core](under-the-hood/contexture-core.md)
+* [Contexture ElasticSearch](under-the-hood/contexture-elasticsearch.md)
+* [Contexture Mongo](under-the-hood/contexture-mongo.md)
+* [Building Your Own Provider](under-the-hood/building-your-own-provider.md)
+* [Contexture Client](under-the-hood/contexture-client.md)
+* [Reactors](under-the-hood/reactors.md)
+* [Contexture React](under-the-hood/contexture-react.md)
+
diff --git a/about-contexture/alternatives-and-benchmarks.md b/about-contexture/alternatives-and-benchmarks.md
@@ -0,0 +1,4 @@
+# Alternatives & Benchmarks
+
+TODO
+
diff --git a/about-contexture/brief-history.md b/about-contexture/brief-history.md
@@ -0,0 +1,4 @@
+# Brief History
+
+TODO
+
diff --git a/about-contexture/glossary-of-terms.md b/about-contexture/glossary-of-terms.md
@@ -0,0 +1,53 @@
+# Glossary of Terms
+
+## Contexture
+
+> NOUN 1. The fact or manner of being woven or linked together to form a connected whole.  
+> 1.1. A mass of things interwoven together; a fabric.  
+> 1.2. The putting together of words and sentences in connected composition; the construct of a text.  
+> 1.3. A connected literary structure; a continuous text.
+
+[Source](https://en.oxforddictionaries.com/definition/us/contexture).
+
+## Domain-Specific Language \(DSL\)
+
+> A domain-specific language \(DSL\) is a computer language specialized to a particular application domain. This is in contrast to a general-purpose language \(GPL\), which is broadly applicable across domains.
+
+[Source](https://en.wikipedia.org/wiki/Domain-specific_language).
+
+## Search Query
+
+According to Wikipedia, `Search Query`, in the context of the `web`, refers to:
+
+> ...a query that a user enters into a web search engine to satisfy his or her information needs. Web search queries are distinctive in that they are often plain text or hypertext with optional search-directives \(such as "and"/"or" with "-" to exclude\). They vary greatly from standard query languages, which are governed by strict syntax rules as command languages with keyword or positional parameters.
+
+[Source](https://en.wikipedia.org/wiki/Web_search_query).
+
+## Faceted Search
+
+> Faceted search, also known as faceted navigation or faceted browsing, is a technique used by eCommerce brands to help users analyze, organize, and filter large sets of product inventory based on filters such as size, color, price, and brand.
+
+[Source](https://www.dynamicyield.com/glossary/faceted-search/).
+
+> Faceted search, also called faceted navigation or faceted browsing, is a technique for accessing information organized according to a faceted classification system, allowing users to explore a collection of information by applying multiple filters. A faceted classification system classifies each information element along multiple explicit dimensions, called facets, enabling the classifications to be accessed and ordered in multiple ways rather than in a single, pre-determined, taxonomic order.
+
+[Source](https://en.wikipedia.org/wiki/Faceted_search).
+
+## Search Filter
+
+> An extension of faceted search, a search filter is a specific product attribute a visitor can use to refine the search results of a particular category listing, e.g. by size, color, price, or brand. Multiple filters may be applied to take a broad range of products and refine them into a more narrow selection, allowing the end user to retrieve the most relevant search results based on the criteria they’ve selected.
+
+[Source](https://www.dynamicyield.com/glossary/search-filter/).
+
+## Configuration Based Development
+
+> The difference between configuration-driven development and model-driven development is that the former is not restricted to the model of the code such as classes, fields, and relationships. Configuration-driven development \(CCD\) encompasses anything that can be configured within your application. For example, if your architecture dictates that particular business rules must be applied consistently across your application, you can use configuration files to configure and apply those rules.
+
+[Source](https://www.ibm.com/developerworks/library/wa-configdev/index.html).
+
+## Functional Logic Programming
+
+> Functional logic programming is the combination, in a single programming language, of the paradigms of functional programming \(including higher-order programming\) and logic programming \(nondeterministic programming, unification\). This style of programming is embodied by various programming languages, including Curry and Mercury.
+
+[Source](https://en.wikipedia.org/wiki/Functional_logic_programming).
+
diff --git a/about-contexture/map-of-repos.md b/about-contexture/map-of-repos.md
@@ -0,0 +1,40 @@
+# Map of Repos
+
+The Contexture framework comes to life through a list of repositories that individually specialize in some needed layer for our architecture. We will be using most \(if not all\) of these projects in our upcoming pages. Let's explore the repos we have so far:
+
+## Contexture Core
+
+[github.com/smartprocure/contexture](https://github.com/smartprocure/contexture) is where our main DSL processor lives. It is a very small layer that ties everything together. This one receives the information about the different search representations, about the databases involved, and the DSL, then outputs the search results respective to each one of the queries described in a copy of the received DSL.
+
+You can read more about the core here:
+
+* [In the repository](https://github.com/smartprocure/contexture).
+
+## Contexture Providers
+
+The Contexture Providers are the interfacing layer that ties the Contexture DSL to the targeted databases. So far, we have only two open source providers:
+
+* [contexture-elasticsearch](https://github.com/smartprocure/contexture-elasticsearch),
+
+  and
+
+* [contexture-mongo](https://github.com/smartprocure/contexture-mongo).
+
+If you are planning to use either ElasticSearch or MongoDB for your project, the best way to get started is to use those repositories. However, if you need to use Contexture with another database, you will need to implement the provider yourself. We're looking for code contributors, so please don't feel limited to the current available tools. Help us grow together!
+
+## Contexture Client
+
+The Contexture Client is responsible for triggering behaviors on the search interfaces by knowing what causes changes in one or more elements of the search tree. It is the key piece of technology that allows our search interfaces to work in real time.
+
+You can read more about the Contexture Client here:
+
+* [In the repository](https://github.com/smartprocure/contexture-client).
+
+## Contexture React
+
+The Contexture React repository holds a list of components that facilitate building search interfaces. They are mainly graphical representations of the types that exist on our Contexture Providers.
+
+You can read more about the Contexture React:
+
+* [In the repository](https://github.com/smartprocure/contexture-client).
+
diff --git a/about-contexture/what-is-contexture.md b/about-contexture/what-is-contexture.md
@@ -0,0 +1,14 @@
+# What Is Contexture
+
+People of the Internet, here we officialy introduce you to `contexture`, our framework for building search interfaces.
+
+This framework is carefully designed to be a generic solution for a universe of unlimited possible search interfaces. We've started with a minimal set of repositories that are representative of tools that empower our business, but are intended to be merely examples. If anything, our approaches are only use cases, for the potential of this tool is ultimately yours to take.
+
+A quick search over the Internet would reveal that the word `contexture` means: `the fact or manner of being woven or linked together to form a connected whole` and also `the putting together of words and sentences in connected composition; the construction of a text`.
+
+Picking `contexture` as the name for this project means that we are trying to expose not only our ultimate intentions, but also more or less how the system is built. The way our projects work is by a DSL that is used to gather different intended search inputs, each one representing some useful abstraction of a search filter \(like an input where you can write a word to be searched, or another where you can filter the search results by one or more options\), then using the values to process a DSL that will end up retrieving values from one or more different databases, then returning these values on the respective sections of the DSL, so that each result can update each one of the components of the user interface. A more detailed description is visible in the following diagram.
+
+The canonical example of a Contexture Node is faceted search, where you have a checkbox list that is both a filter \(in the sense that it restricts results based on the checked values\) and an aggregation \(which shows the top n values that can be checked\). Contexture allows them to be nested in advanced searches with boolean joins like `and`/`or`/`not`.
+
+This thought process will become more clear as we progress through the docs. Hopefully, some pages later it will be easy to grasp how we provide a new perspective on building search interfaces, and perhaps even how you can use it to power up your business, just like we have been doing for almost a decade.
+
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+docs.contexture.site
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,70 @@
+<!doctype html>
+<!--
+
+  Instructions:
+
+  - Save this file.
+  - Replace "ltchris" with your GitHub username.
+  - Replace "Contexture" with your GitHub repo name.
+  - Replace "Contexture" with your project name.
+  - Upload this file (or commit to GitHub Pages).
+
+  Customize as you see fit!
+
+-->
+<html>
+<head>
+  <meta charset='utf-8'>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+  <meta name="viewport" content="width=device-width">
+
+  <link href='https://fonts.googleapis.com/css?family=Lato' rel='stylesheet'>
+
+  <title>Contexture</title>
+
+  <!-- Flatdoc -->
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+  <script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/legacy.js'></script>
+  <script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/flatdoc.js'></script>
+
+  <!-- Flatdoc theme -->
+ <link  href='style.css' rel='stylesheet'>
+ <script src='script.js'></script> 
+
+
+  <!-- Meta -->
+  <meta content="Contexture" property="og:title">
+  <meta content="Contexture - The Contexture DSL (Domain Specific Language) Processor." name="description">
+
+  <!-- Initializer -->
+  <script>
+    Flatdoc.run({
+      fetcher: Flatdoc.github('ltchris/contexture-docs')
+    });
+  </script>
+</head>
+<body role='flatdoc' class='no-literate large-brief'>
+
+  <div class='header'>
+    <div class='left'>
+      <h1>Contexture</h1>
+      <ul>
+        <li><a href='https://github.com/smartprocure/contexture'>View on GitHub</a></li>
+        <li><a href='https://github.com/smartprocure/contexture/issues'>Issues</a></li>
+      </ul>
+    </div>
+    <div class='right'>
+      <!-- GitHub buttons: see http://ghbtns.com -->
+      <iframe src="https://ghbtns.com/github-btn.html?user=smartprocure&amp;repo=contexture&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
+    </div>
+  </div>
+
+  <div class='content-root'>
+    <div class='menubar'>
+      <div class='menu section' role='flatdoc-menu'></div>
+    </div>
+    <div role='flatdoc-content' class='content'></div>
+  </div>
+
+</body>
+</html>