Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Restructuring the documentation

Aperta
  • Qualcosa non va?
#537 15 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Inizia esaminando la documentazione attuale di Syncthing e il modello di documentazione Divio collegato. Individua come i contenuti esistenti corrispondono a tutorial, guide pratiche, riferimento e spiegazione, quindi definisci un ambito concreto per la ristrutturazione. Il lavoro sarà considerato completato quando la community avrà raggiunto un accordo sulla struttura proposta e sarà disponibile un piano operativo per riorganizzare la documentazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

I wanted to add an FAQ on how to copy an existing Syncthing configuration to a new system (and removing keys.pem on the new one). 😅 But in course of that I noticed something about the Syncthing documentation.

I really like this idea for structuring documentation. It involves organizing documentation into four categories - tutorial, how-to guides, reference, and explanation.

My personal understanding of it is -

  1. tutorials are for beginners, teaching them about basic usage, solely in terms of actions (with no 'explanations' of underlying concepts), and trying to make it fun.
  2. how-to guides are for achieving specific goals, with some scope for variation. Meant for users who have gotten past the tutorials, and are trying to meet specific usage/configuration needs.
  3. the explanation is for describing the design of the software at a high level, and how it came to be - how various components of the project fit together. Meant to guide beginner contributors in exploring the source, and power users trying to gain a deeper understanding of the software.
  4. the reference documentation is for describing the software in detail - functions, variables, classes, methods, and their correct use (with no awareness of 'use for a particular purpose'; that's for the how-to guides). Meant for experienced contributors looking up a definition or its usage, or trying to get an overview of the API, without dealing with the implementation (source code) or how it fits together (explanation).

In comparison, in Syncthing's current documentation, those concerns are mixed up rather haphazardly, I'm sorry to say.

I'd like to try to restructure Syncthing's documentation in this manner, because I believe it would be greatly improved by it.

What does the community say?

Lingua principale
Python
Stelle
327
Fork
654
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di syncthing/docs

Tutte le issue di syncthing/docs

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.