sillsdev / sillsdev/langtechdepot

Step-4 illustration shows invented folder names; check them against the real catalog

Open
#16 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
0
Forks
2
Avg merge
4d 21h
Merged PRs (30d)
2

Description

The step-4 illustration on both platform pages shows two invented catalogue entries:

  • "Software packages — Paratext, FieldWorks, fonts"
  • "Training videos — Courses and walkthroughs"

I made those up; I have no visibility of the real catalogue, which lives on the California server. If the actual folder IDs differ, the picture is teaching people to look for something they will not see, which is worse than no picture.

Two things to check against a real client:

  • the folder names and descriptions in the illustration match what Syncthing actually offers
  • the surrounding wording is right for Syncthing 2 — the site says offers "appear at the top" of the page at 127.0.0.1:8384 with an Add button, and the header in the drawing reads "NEW FOLDERS OFFERED TO THIS DEVICE"

Both are a few lines of inline SVG in docs/windows.html and docs/linux.html. Note that folder IDs are permanent and user-visible, so once the illustration is right it should stay right.

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 with the inline SVG illustrations in docs/windows.html and docs/linux.html. Compare the folder names and descriptions with the real Syncthing client, then verify the surrounding wording, including the offers location, Add button, and header. Done means both illustrations show the real catalogue and accurate Syncthing 2 wording.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.