From 764398c27435df182dfee86626b7f67b208e2538 Mon Sep 17 00:00:00 2001
From: Severyn Kozak
Date: Wed, 18 Jun 2014 11:41:36 -0400
Subject: [PATCH] Work on #74. Add docs route, partly-skeleton page.
Add:
templates/docs.html
-Add a skeleton structure for the documentation page.
-Add some content to certain sections.
---
app.py | 4 ++++
templates/docs.html | 41 +++++++++++++++++++++++++++++++++++++++++
templates/layout.html | 1 +
3 files changed, 46 insertions(+)
create mode 100644 templates/docs.html
diff --git a/app.py b/app.py
index 2772677..8192c07 100644
--- a/app.py
+++ b/app.py
@@ -55,6 +55,10 @@ def about():
def developers():
return render_template("developers.html")
+@app.route("/docs")
+def docs():
+ return render_template("docs.html")
+
@app.errorhandler(404)
def error404(error):
return render_template("error404.html"), 404
diff --git a/templates/docs.html b/templates/docs.html
new file mode 100644
index 0000000..70fd7f9
--- /dev/null
+++ b/templates/docs.html
@@ -0,0 +1,41 @@
+= extends "layout.html"
+
+= block title
+ docs
+= endblock
+
+= block body
+ Usage
+
+ bitshift is a search-engine optimized for source code: beyond supporting searches with the full range of ASCII
+ symbols, the engine understands code, allowing users to query for metadata, like time of creation/last
+ modification, programming language, and even symbols like function names and variables. Basic use boils down to
+ general and advanced searches.
+
+
general search
+
+ To perform a "general search," simply place your cursor in the search bar on our home page and begin typing; when
+ you stop typing for a short period of time, we'll automtically execute a query for you. As you scroll down the
+ results page, the front-end will query our server and seamlessly load more and more results.
+
+
+ advanced search
+
+ General searches, though, are limited. To allow users to make the best of our engine, we created an advanced
+ search form that allows the creation of complex queries.
+
+
search fields
+
+
+
+ search groups
+
+
+
+
+ Handwritten Queries
+
+
+ Get involved
+
+= endblock
diff --git a/templates/layout.html b/templates/layout.html
index 6c6ab8d..d5db6ae 100644
--- a/templates/layout.html
+++ b/templates/layout.html
@@ -40,6 +40,7 @@