syncthing / syncthing/docs

Restructuring the documentation

Open
#537 15 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
327
Forks
653
PR merge metrics
No merged PRs in 30d

Description

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?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current Syncthing documentation and the linked Divio documentation model. Identify how existing content maps to tutorials, how-to guides, reference, and explanation, then define a concrete restructuring scope. Done requires community agreement on the proposed structure and an actionable plan for reorganizing the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.