Skip to content

Commit

Permalink
WIP Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vanvianen committed Jan 2, 2024
1 parent f9cc50f commit f28f3dd
Show file tree
Hide file tree
Showing 42 changed files with 213 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
www.hue.gl
10 changes: 10 additions & 0 deletions docs/about/authors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Authors

**hue.gl** is an open-source project by [Scape Agency](https://www.scape.agency "Scape Agency website").

## Scape Agency

Scape Agency is a spatial innovation collective that dreams, discovers and designs the everyday of tomorrow. We blend design thinking with emerging technologies to create a brighter perspective for people and planet. Our products and services naturalise technology in liveable and sustainable –scapes that spark the imagination and inspire future generations.

- website: [scape.agency](https://www.scape.agency "Scape Agency website")
- github: [github.com/scape-agency](https://github.com/scape-agency "Scape Agency Github")
Binary file added docs/assets/favicon/favicon.ico
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-bold.otf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-bold.ttf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-bold.woff2
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-extrabold.otf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-extrabold.ttf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-extrabold.woff2
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-extralight.otf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-extralight.ttf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-extralight.woff2
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-light.otf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-light.ttf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-light.woff2
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-medium.otf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-medium.ttf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-medium.woff2
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-regular.otf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-regular.ttf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-regular.woff2
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-semibold.otf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-semibold.ttf
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-semibold.woff2
Binary file not shown.
Binary file added docs/assets/font/manrope/manrope-variable.ttf
Binary file not shown.
Binary file not shown.
Binary file added docs/assets/image/scape_agency-logo_dark.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/image/scape_agency-logo_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file added docs/assets/script/extra.js
Empty file.
16 changes: 16 additions & 0 deletions docs/assets/style/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
@import url('https://fonts.googleapis.com/css2?family=Manrope&display=swap');
@font-face {
font-family: "Manrope";
src: "fonts/manrope/manrope-regular.woff2";
}
:root {
--md-text-font: "Manrope";
}
.md-footer__inner {
display: none;
}
[data-md-color-scheme="scapeagency"] {
--md-primary-fg-color: rgb(0, 0, 15);
--md-primary-fg-color--light: #ffffff;
--md-primary-fg-color--dark: rgb(0, 0, 15);
}
Binary file added docs/favicon.ico
Binary file not shown.
11 changes: 11 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<header>
<p align="center">
<img src="assets/image/logo_dark.png" width="20%" height="20%" alt="hue.gl Logo">
</p>
<h1 align='center' style='border-bottom: none;'>hue.gl</h1>
<!-- <h3 align='center'></h3> -->
</header>
<br/>


**hue.gl** is an open-source project by [Scape Agency](https://www.scape.agency "Scape Agency website").
3 changes: 3 additions & 0 deletions docs/legal/disclaimer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Disclaimer

**THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
Empty file added docs/legal/license.md
Empty file.
144 changes: 144 additions & 0 deletions docs/legal/privacy_policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
__Last revised on January 1, 2023__

Scape Agency BV will collect certain non-personally identify information
about you as you use our sites. We may use this data to better understand our
users. We can also publish this data, but the data will be about a large group
of users, not individuals.

We will also ask you to provide personal information, but you'll always be able
to opt out. If you give us personal information, we won't do anything evil with
it.

We can also use cookies, but you can choose not to store these.

That's the basic idea, but you must read through the entire Privacy Policy
below and agree with all the details before you use any of our sites.

## Reuse

This document is based upon the Automattic Privacy Policy and is licensed under
Creative Commons Attribution Share-Alike License 2.5. Basically, this means you
can use it verbatim or edited, but you must release new versions under the same
license and you have to credit Automattic somewhere (like this!). Automattic is
not connected with and does not sponsor or endorse Scape Agency BV or
its use of the work.

Scape Agency BV ("Scape Agency") makes available services such as
our web sites, including
[www.scape.agency](https://www.scape.agency), our API, and any other
software, sites, and services offered by Scape Agency BV in connection
to any of those (taken together, the "Service"). It is Scape Agency BV's
policy to respect your privacy regarding any information we may collect while
operating our websites.

## Questions

If you have question about this Privacy Policy, please contact us at:
[info@scape.agency](mailto:info@scape.agency)

## Visitors

Like most website operators, Scape Agency BV collects
non-personally-identifying information of the sort that web browsers and
servers typically make available, such as the browser type, language
preference, referring site, and the date and time of each visitor request.
Scape Agency BV's purpose in collecting non-personally identifying
information is to better understand how Scape Agency BV's visitors
use its website. From time to time, Scape Agency BV may release
non-personally-identifying information in the aggregate, e.g., by publishing a
report on trends in the usage of its website.

Scape Agency BV also collects potentially personally-identifying
information like Internet Protocol (IP) addresses. Scape Agency BV does
not use such information to identify its visitors, however, and does not
disclose such information, other than under the same circumstances that it uses
and discloses personally-identifying information, as described below. We may
also collect and use IP addresses to block users who violated our Terms of
Service.

## Gathering of Personally-Identifying Information

Certain visitors to Scape Agency BV's websites choose to interact with
Scape Agency BV in ways that require Scape Agency BV to gather
personally-identifying information. The amount and type of information that
Scape Agency BV gathers depends on the nature of the interaction.
Scape Agency BV collects such information only insofar as is necessary
or appropriate to fulfill the purpose of the visitor's interaction with
Scape Agency BV. Scape Agency BV does not disclose
personally-identifying information other than as described below. And visitors
can always refuse to supply personally-identifying information, with the caveat
that it may prevent them from engaging in certain Service-related activities.

Additionally, some interactions, such as posting a comment, may ask for
optional personal information. For instance, when posting a comment, may
provide a website that will be displayed along with a user's name when the
comment is displayed. Supplying such personal information is completely
optional and is only displayed for the benefit and the convenience of the user.

## Aggregated Statistics

Scape Agency BV may collect statistics about the behavior of visitors to
the Service. For instance, Scape Agency BV may monitor the most popular
parts of the URL of its sites and services. Scape Agency BV may display
this information publicly or provide it to others. However,
Scape Agency BV does not disclose personally-identifying information
other than as described below.

## Protection of Certain Personally-Identifying Information

Scape Agency BV discloses potentially personally-identifying and
personally-identifying information only to those of its employees, contractors
and affiliated organizations that (i) need to know that information in order to
process it on Scape Agency BV's behalf or to provide services available
at Scape Agency BV's websites, and (ii) that have agreed not to disclose
it to others. Some of those employees, contractors and affiliated organizations
may be located outside of your home country; by using the Service, you consent
to the transfer of such information to them. Scape Agency BV will not
rent or sell potentially personally-identifying and personally-identifying
information to anyone. Other than to its employees, contractors and affiliated
organizations, as described above, Scape Agency BV discloses potentially
personally-identifying and personally-identifying information only when
required to do so by law, or when Scape Agency BV believes in good faith
that disclosure is reasonably necessary to protect the property or rights of
Scape Agency BV, third parties or the public at large. If you are a
registered user of the Service and have supplied your email address,
Scape Agency BV may occasionally send you an email to tell you about new
features, solicit your feedback, or just keep you up to date with what's going
on with Scape Agency BV and our products. We primarily use our website
and blog to communicate this type of information, so we expect to keep this
type of email to a minimum. If you send us a request (for example via a support
email or via one of our feedback mechanisms), we reserve the right to publish it
in order to help us clarify or respond to your request or to help us support
other users. Scape Agency BV takes all measures reasonably necessary to
protect against the unauthorized access, use, alteration or destruction of
potentially personally-identifying and personally-identifying information.

## Cookies

A cookie is a string of information that a website stores on a visitor's
computer, and that the visitor's browser provides to the Service each time the
visitor returns. Scape Agency BV uses cookies to help
Scape Agency BV identify and track visitors, their usage of
Scape Agency BV Service, and their Service access preferences.
Scape Agency BV visitors who do not wish to have cookies placed on their
computers should set their browsers to refuse cookies before using
Scape Agency BV's websites, with the drawback that certain features of
Scape Agency BV's websites may not function properly without the aid of
cookies.

## Data Storage

Scape Agency BV uses third party vendors and hosting partners to provide
the necessary hardware, software, networking, storage, and related technology
required to run the Service. You understand that although you retain full
rights to your data, it may be stored on third party storage and transmitted
through third party networks.

## Privacy Policy Changes

Although most changes are likely to be minor, Scape Agency BV may change
its Privacy Policy from time to time, and in Scape Agency BV's sole
discretion. Scape Agency BV encourages visitors to frequently check this
page for any changes to its Privacy Policy. Your continued use of this site
after any change in this Privacy Policy will constitute your acceptance of
such change.
7 changes: 7 additions & 0 deletions docs/overrides/_main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{% extends "base.html" %}

{% block announce %}
<div>
<strong> unit.gl is currently a <i>Work in Progress</i></strong>
</div>
{% endblock %}
3 changes: 3 additions & 0 deletions docs/quick_start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Quick Start

## Installation
1 change: 1 addition & 0 deletions docs/resources/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Glossary
1 change: 1 addition & 0 deletions docs/resources/links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Links
8 changes: 8 additions & 0 deletions docs/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# www.robotstxt.org/

# Allow crawling of all content
User-agent: *
Disallow:


SITEMAP: http://www.hue.gl/sitemap.xml
8 changes: 8 additions & 0 deletions docs/security.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Canonical
Canonical: https://www.hue.gl/security.txt

# Contact
Contact: mailto:info@scape.agency

# Preferred-Languages
Preferred-Languages: en

0 comments on commit f28f3dd

Please sign in to comment.