Hopiu/django-admin2
1
0
Fork 0
mirror of https://github.com/jazzband/django-admin2.git synced 2026-03-16 22:20:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

per #240, this adds indexing to the design document

Browse source
This commit is contained in:
Daniel Greenfeld 2013-07-16 20:32:46 +02:00
parent d1a4b849ab
commit 29425ea5e4
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/design.rst
View file

@ -2,6 +2,9 @@
Design
======
.. index:: Design
single: Design; Constraints
Constraints
------------
@ -12,6 +15,9 @@ This section outlines the design constraints that django-admin2 follows:
3. External package dependencies are allowed but should be very limited.
4. Building a django-admin2 theme cannot involve learning Python, which explains why we are not using tools like django-crispy-forms. (One of our goals is to make it easier for designers to explore theming django-admin2).
.. index::
single: Design; Backend Goals
Backend Goals
---------------
@ -30,6 +36,9 @@ Clean code with substantial documentation is also a goal:
2. All classes/methods/functions documented.
3. Provide a wealth of in-line code documentation.
.. index::
single: Design; REST API Goals
REST API Goals
----------------
@ -41,6 +50,9 @@ Goals:
2. Reuse components from the HTML view.
3. Backwards compatibility: Use a easily understood API versioning system so we can expand functionality of the API without breaking existing themes.
.. index::
single: Design; UI Goals
UI Goals
---------