Commit a9e2483d authored by Robert Knight's avatar Robert Knight Committed by GitHub

Merge pull request #294 from hypothesis/docs-adrs-tweaks

Docs adrs tweaks
parents 11abab35 e809311a
ADR 1: Component architecture for sidebar application ADR 1: Component Architecture for Sidebar Application
===================================================== =====================================================
Context Context
...@@ -36,7 +36,7 @@ controllerAs). Angular JS 1.5x introduced [explicit ...@@ -36,7 +36,7 @@ controllerAs). Angular JS 1.5x introduced [explicit
support](https://docs.angularjs.org/guide/component) for this architecture via support](https://docs.angularjs.org/guide/component) for this architecture via
`.component()`. `.component()`.
### Components in the client ### Components in the Client
The client historically used traditional Angular 1.x methods of passing data The client historically used traditional Angular 1.x methods of passing data
between parts of the UI - properties on the scope inherited by child scopes and between parts of the UI - properties on the scope inherited by child scopes and
......
Architecture decision records Architecture Decision Records
============================= =============================
Here you will find documents which describe significant architectural decisions Here you will find documents which describe significant architectural decisions
...@@ -6,6 +6,11 @@ made or proposed when developing the Hypothesis client. We record these in ...@@ -6,6 +6,11 @@ made or proposed when developing the Hypothesis client. We record these in
order to provide a reference for the history, motivation, and rationale for past order to provide a reference for the history, motivation, and rationale for past
decisions. decisions.
See [the See
introduction in the "h" repository](https://github.com/hypothesis/h/blob/master/docs/arch/index.rst) `the introduction in the h repository <https://github.com/hypothesis/h/blob/master/docs/arch/index.rst>`_
for more details. for more details.
.. toctree::
:maxdepth: 1
adr-001
...@@ -5,8 +5,9 @@ This section contains documentation for **developers** contributing code to ...@@ -5,8 +5,9 @@ This section contains documentation for **developers** contributing code to
the Hypothesis client. the Hypothesis client.
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 2
developing developing
security security
envvars envvars
arch/index
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment