leonardopolicarpo/iot-firmware-update

Create project documentation (READMEs in EN and PT-BR)

Open

#6 opened on Sep 2, 2025

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (0 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

A good project needs good documentation. Create the main README.md in English and a README.pt-br.md in Portuguese.

Tasks:

[ ] Write the main README.md in English, including:

  • Project objective
  • Architecture overview
  • Tech stack
  • How to run locally (docker compose up)
  • API endpoint usage

[ ] Write the README.pt-br.md with the same content, translated to Portuguese

Contributor guide

Research direction
Review the project structure and existing code, then create README.md in English and README.pt br.md in Portuguese following the tasks listed.
Tech stack
typescriptdockeraws
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90