From 1a6aa512cbbadc6bc65de5bbbb5cd0bf6aa711ff Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Sat, 15 Feb 2025 23:22:05 -0600 Subject: [PATCH] Add Documentation --- Documentation.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 Documentation.md diff --git a/Documentation.md b/Documentation.md new file mode 100644 index 0000000..46a6f2b --- /dev/null +++ b/Documentation.md @@ -0,0 +1,28 @@ +# Rattail Project Documentation + +There is quite a bit to the Rattail project, and some of it isn't very well documented yet. + +Nonetheless, we'll try here to provide as complete a picture as we can, of the existing docs. + +## Getting Started + +**NOTE:** *Please see the [[https://rattailproject.org/docs/rattail-manual/|Rattail Manual]] for the most "comprehensive" docs. That manual is also not yet complete, but eventually will replace most or all of this wiki.* + +Here are some entry points to this wiki, specific to target audience: + + * [Developers](Documentation-DevGuide.-) + * [System Administrators](Documentation-AdminGuide.-) + * [End Users](Documentation-UserGuide.-) + +Or, see this [Concept Guide](Documentation-ConceptGuide.-) to learn more about what Rattail is / can do. + +Or, see the docs for [Theo, the order system](Theo). + +## Package Documentation + +Some documentation is maintained along with the various Python software packages. This is where you'll hopefully find more thorough (aka. narrative) treatment of the concepts involved, as well as the API docs, etc. Probably only useful for developers, and perhaps administrators. + + * [[https://rattailproject.org/docs/rattail/|rattail]] + * [[https://rattailproject.org/docs/tailbone/|tailbone]] + +See also the [[https://rattailproject.org/docs/|full list]] in case the list shown above is incomplete.