Skip to content

Commit 2d76830

Browse files
committed
Improve docs index
1 parent 87879a5 commit 2d76830

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

docs/index.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,50 @@
66
Democrasite Documentation
77
======================================================================
88

9+
10+
|Built with Cookiecutter Django| |Ruff| |Continuous integration| |Coverage report| |Documentation status|
11+
12+
.. |Built with Cookiecutter Django| image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter
13+
:target: https://github.com/pydanny/cookiecutter-django/
14+
15+
.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
16+
:target: //github.com/astral-sh/ruff
17+
18+
.. |Continuous integration| image:: https://github.com/mfosterw/cookiestocracy/actions/workflows/ci.yml/badge.svg
19+
:target: https://github.com/mfosterw/cookiestocracy/actions/workflows/ci.yml
20+
21+
.. |Coverage report| image:: https://codecov.io/gh/mfosterw/cookiestocracy/graph/badge.svg?token=NPV1TLXZIW
22+
:target: https://codecov.io/gh/mfosterw/cookiestocracy
23+
24+
.. |Documentation status| image:: https://readthedocs.org/projects/cookiestocracy/badge/?version=latest
25+
:target: https://cookiestocracy.readthedocs.io/en/latest/?badge=latest
26+
27+
28+
:License: MIT
29+
30+
Democrasite is a website which automatically merges changes based on popular
31+
approval. For more information on the nature and purpose of the project, visit
32+
our `about page`_. This page is meant for people who want to fork the
33+
repository and/or contribute to the project. This project is approximately in beta
34+
development (hence the repository being named "cookiestocracy" - a reference
35+
to cookiecutter and `kakistocracy`_). The alpha version is `here`_ and the
36+
full version doesn't exist yet.
37+
38+
* Homepage:
39+
https://democrasite.dev
40+
* Source code:
41+
https://github.com/mfosterw/cookiestocracy
42+
* Documentation:
43+
https://cookiestocracy.readthedocs.io/en/latest/
44+
45+
.. _`about page`: https://democrasite.dev/about/
46+
.. _`kakistocracy`: https://en.wikipedia.org/wiki/Kakistocracy
47+
.. _`here`: https://github.com/mfosterw/democrasite-testing
48+
49+
950
.. toctree::
1051
:maxdepth: 2
52+
:titlesonly:
1153
:caption: Contents:
1254

1355
README

0 commit comments

Comments
 (0)