Zlepšení dokumentace pro vývojáře #38

Open
opened 2026-02-04 14:28:57 +01:00 by batmanisko · 0 comments
Member

Feature: Improved Developer Documentation

FeatureRequest enum: DEVELOPMENT
Description: Zlepšení dokumentace/postupů pro ostatní vývojáře

Implementation Notes

Improve project documentation and developer onboarding experience.

Key files to modify:

  • README.md – Expand setup instructions, architecture overview
  • Dev scripts – Improve/add development convenience scripts
  • TODO.md – Keep updated with current state

Approach:

  1. Expand README with:
    • Architecture overview (client/server structure, tech stack)
    • Complete development setup guide (prerequisites, environment variables, first run)
    • API documentation or link to auto-generated docs
  2. Add/improve dev scripts for common tasks
  3. Document the database schema and data flow
  4. Add contribution guidelines
  5. Keep TODO.md synchronized with Gitea issues
## Feature: Improved Developer Documentation **FeatureRequest enum:** `DEVELOPMENT` **Description:** Zlepšení dokumentace/postupů pro ostatní vývojáře ### Implementation Notes Improve project documentation and developer onboarding experience. **Key files to modify:** - `README.md` – Expand setup instructions, architecture overview - Dev scripts – Improve/add development convenience scripts - `TODO.md` – Keep updated with current state **Approach:** 1. Expand README with: - Architecture overview (client/server structure, tech stack) - Complete development setup guide (prerequisites, environment variables, first run) - API documentation or link to auto-generated docs 2. Add/improve dev scripts for common tasks 3. Document the database schema and data flow 4. Add contribution guidelines 5. Keep TODO.md synchronized with Gitea issues
batmanisko added the Vylepšení label 2026-02-04 14:30:17 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Marbes/Luncher#38