Metadata-Version: 2.5
Name: django-dg-wiki
Version: 1.0.0
Summary: A wiki for Django that people and AI agents write together, next to the board.
Project-URL: Homepage, https://github.com/datagroceries/django-dg
Project-URL: Source, https://github.com/datagroceries/django-dg
Project-URL: Documentation, https://github.com/datagroceries/django-dg/blob/main/docs/integrating.md
Project-URL: Changelog, https://github.com/datagroceries/django-dg/blob/main/packages/django-dg-wiki/CHANGELOG.md
Author: Jasper Cramwinckel
License-Expression: MIT
License-File: LICENSE
Keywords: ai agents,django,documentation,knowledge base,mcp,wiki
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Classifier: Framework :: Django :: 6.1
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Office/Business :: Groupware
Requires-Python: >=3.11
Requires-Dist: django-dg-core>=1.0
Requires-Dist: django-simple-history
Requires-Dist: django>=5.2
Description-Content-Type: text/markdown

# django-dg-wiki

A wiki for a Django project, that people and AI agents write together, next to the board. Part of
[DataGroceries](https://github.com/datagroceries/django-dg).

## What it does

- Pages in Markdown, in one tree: a page with pages under it is what elsewhere is a space or a folder.
  Addresses follow the tree (`dg/wiki/engineering/deploying/`), and a page renamed or moved keeps its
  old address leading to it. Pages are put in order, or under another, by dragging them in the tree.
- Links between pages, `[[Engineering/Deploying]]`, also from a ticket's text: by the end of an address
  (`[[Deploying]]`), the whole of it (`[[/Engineering/Deploying]]`), or from the page they are in, as in
  a folder (`[[./Rollback]]` under it, `[[../Onboarding]]` beside it). A page lists the pages that link to
  it, and the links follow when a page is renamed or moved.
- The Markdown editor of every DataGroceries app, and a table of contents beside a long page.
- Every save kept, with who made it and through which agent; two versions compared side by side, and an
  earlier one brought back. A save is refused when someone else saved the page in the meantime.
- Images in the text, pasted or dropped into the editor, and files beside a page.
- Comments and replies, with @-mentions; the people watching a page hear about new comments.
- Search through every page's title and text, and pages downloaded as Markdown: one page as a file, or
  a page with all under it, or the whole wiki, as a zip with their images, the links between them kept.
- A page in several languages: each translation beside it, linked to the others, and told when the page
  it translates changed after it.
- A REST API and MCP tools for everything the pages do but uploading and downloading files, and on a
  ticket, while the board is installed too, the wiki pages that name it.
- English and Dutch, following the project's language.

## Installing

As every DataGroceries app, described in
[docs/integrating.md](https://github.com/datagroceries/django-dg/blob/main/docs/integrating.md): add `'datagroceries.wiki'`
to `INSTALLED_APPS` after `'datagroceries.core'`, run `manage.py migrate`, and grant the permission "Can use the
wiki" (`dg_wiki.use`) to a group. The pages are at `dg/wiki/`.

MIT licensed.
