italia/developers-italia-api

Provide an overview documentation of the various components

Open

#306 opened on Mar 25, 2026

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (8 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (16 stars)
PR merge metrics
 (Avg merge 6h 43m) (22 merged PRs in 30d)

Description

Document how the tools and the system work together with diagrams and such, much like the nice work the Swiss catalog has done in the README: https://github.com/swiss/oss-catalog

It doesn't necessarily need to happen in this repo, but let's have this issue here as a placeholder.

Contributor guide

Research direction
Review the Swiss catalog README for inspiration and create a high level overview documentation with diagrams explaining how the various components work together.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80