Benvenuto nella Documentazione di BlackTrails

Qui troverai tutto ciò che ti serve per comprendere e lavorare con BlackTrails: la nostra filosofia, i principi fondamentali che guidano la comunità e la logica che sostiene il nostro ecosistema tecnologico.

La documentazione è organizzata in sezioni, ognuna rappresentata da una cartella sotto content/docs/. Ogni sezione ha il proprio meta.json, che ne definisce il titolo, l'ordine nella sidebar e l'elenco dei file .mdx inclusi. Ogni file .mdx ha un frontmatter (title, description) che controlla come appare nella navigazione.

In questo modo, la documentazione è:

• Modulare → aggiungi o rimuovi sezioni senza rompere la struttura.
• Localizzata → ogni .mdx può avere .it.mdx, .en.mdx, ecc.
• Coerente → sidebar e routing sono generati automaticamente dal contenuto.

Struttura della documentazione

La documentazione pubblica è divisa in sezioni come:

• Getting Started → orientamento, come iniziare, basi tecniche.
• Vision → i 10 Principi Fondamentali e le nostre fondamenta filosofiche.
• Sezioni future → dedicate a funzionalità, roadmap e integrazioni.

Ogni sezione vive all'interno della propria cartella, per esempio:

content/docs/
  meta.json            # indice principale
  index.mdx            # pagina di benvenuto (questo file)
  getting-started/
    meta.json
    overview.mdx
  vision/
    meta.json
    core-principle.mdx

Esempio di codice

Qui sotto un semplice esempio in Python, mostrato per illustrare l'evidenziazione della sintassi nelle pagine di documentazione:

def hello_blacktrails():
    print("Benvenuto nella Documentazione di BlackTrails!")

Immagini

Le pagine di documentazione supportano immagini con zoom e rendering responsive. Per esempio, l'immagine qui sotto mostra il layout della documentazione BlackTrails:

Liste

Questo è un esempio di come vengono renderizzate le liste:

• Organizzazione chiara e modulare
• Supporto multilingua (IT/EN/…)
• Generazione automatica della sidebar

La filosofia dietro la documentazione

In BlackTrails, la documentazione non è solo un manuale: è parte della nostra trasparenza e del nostro approccio alla comunità.

Aprendo i nostri principi, la nostra logica di sviluppo e l'organizzazione del codice, rendiamo il progetto accessibile e verificabile da tutti.

La documentazione è al tempo stesso:

• Un riferimento tecnico per chi costruisce con noi,
• Una guida filosofica per chi vuole comprendere la visione che sostiene BlackTrails.