How should I report outdated docs or suggest edits to the wiki?

silfilim
Fri, 27 Mar 2020 07:37:58 +0000

I've been reading the docs after joining the site (hi!) and noticed a few places that were either outdated or unclear. Should I ignore them, given the disclaimer on the Instructions doc that says docs may not be current? Or is it better to report them?

Here's a list of what I noticed for context:

Docs, outdated: User settings: Marking new comments - this is now the default for logged in users and has been replaced by the "Collapse old comments when I return to a topic" setting.

Docs, minor typo: Commenting on Tildes: "Noise" label - "with no and Offtopic labels" seems to be missing a word between "no" and "and".

Docs, minor confusion: Navigating Tildes: Comment highlights - the meaning of "Linked comment" wasn't immediately clear to me.

Wiki, outdated: ~tildes wiki: Introduction: Settings - mentions the "mark new comments" settings

I recommend setting up [..] and toggle marking new comments to highlight new comments in a thread.

Some guidance on what to do with discoveries like these will be helpful for those who read docs :)
I'm not really asking them to be updated here and now, but that's a fine outcome of this post too.

Comments URL: https://tildes.net/~tildes/n8g/how_should_i_report_outdated_docs_or_suggest_edits_to_the_wiki

Votes: 13

Comments: 8