rattail/moin-archive
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add Documentation

Lance Edgar 2025-02-15 23:22:05 -06:00
parent e4a79ec236
commit 1a6aa512cb
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
Documentation.md Normal file

@ -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.