This directory is the Markdown documentation hub for Amir. To keep languages aligned, Persian
README files have no prefix, and the English version of the same README is named
README.en.md.
Main Paths
| Path | Audience | Description |
|---|---|---|
| Ordinary user guide | Non-developer users | Day-to-day operations, attendance, salary, inventory, and fiscal years |
| Accounting concepts | Users and developers | Accounting concepts, COGS, purchase/sales returns, and fiscal years |
| Programmer guide | Developers | Architecture, database, testing, and scripts |
| Installation guide | System admins and developers | Installation with Docker Compose, single-command Docker, or standard setup |
| Fiscal year | Everyone | What a fiscal year is and how to create one in Amir |
| Fiscal-year export/import | System admins and developers | The fiscal-year:export and fiscal-year:import commands
|
All Documentation Files
| File | Category | Description |
|---|---|---|
| INSTALLATION / EN | Installation | Persian and English installation guides |
| user/README / EN | Ordinary user | Secondary index for practical and accounting documentation |
| accounting/README / EN | Accounting | Accounting concepts index |
| developer/README / EN | Programmer | Secondary index for technical documentation |
| user/attendance/README / EN | Attendance | Work shifts, logs, imports, and monthly attendance |
| user/salary/README / EN | Salary and payroll | Payroll elements, salary decrees, and payrolls |
| user/inventory-costing / EN | Inventory accounting | COGS, costing methods, and Amir's selected method |
| fiscal-year / EN | Fiscal year | Fiscal-year concept and creation guide |
| FiscalYearExportImport | Fiscal year | Exporting and importing fiscal-year data |
| accounting-basics | Accounting | Accounting basics, debit, credit, and documents |
| return-sell-return-buy | Inventory accounting | Sales returns and purchase returns |
| project-structure | Technical | Laravel project structure |
| database-guide | Technical | Database structure and relationships |
| testing-guide | Technical | Testing guide and test execution |
| script/README | Tools | Migration and data script documentation |
Documentation Maintenance
- Every Persian README should stay structurally aligned with its English README counterpart.
- When a new file is added under
docs/, reference it here or in one of the two secondary indexes. - If a document is useful to ordinary users, include it in user/README.en.
- If a document is about development or internal structure, include it in developer/README.en.