REST API documentation page references commandline option that does not exist anymore on the commandline options page
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 327
- Forks
- 653
- PR merge metrics
- No merged PRs in 30d
Description
What happened?
The page is - https://docs.syncthing.net/rest/system-reset-post.html
The text is Caution: See --reset-database for .stfolder creation side-effect and caution regarding mountpoints.
--reset-database is not referenced here - https://docs.syncthing.net/users/syncthing.html
But it was in the 1.x pages - https://docs.syncthing.net/v1.30.0/users/syncthing.html#cmdoption-reset-database
Syncthing version
v2.0.10
Platform & operating system
Linux (64-bit Intel/AMD Container)
Browser version
No response
Relevant log output
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare docs/rest/system-reset-post.html with docs/users/syncthing.html and the archived v1.30.0 command-option page. Start by checking the referenced caution and the current command-line option list, then update the REST API documentation so it no longer points to an unavailable option. Done means the current page has an accurate reference and the generated documentation builds successfully.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100