Welcome to Codidact Meta!
Codidact Meta is the meta-discussion site for the Codidact community network and the Codidact software. Whether you have bug reports or feature requests, support questions or rule discussions that touch the whole network – this is the site for you.
Comments on Help page: call for improvement suggestions
Parent
Help page: call for improvement suggestions
At the top right of each page is a link to Help.
If you want a specific help article to be edited or added, please raise that on your community specific Meta so that a moderator can make those changes for you. This question is instead about changes that moderators cannot currently make.
If there is something about the help system that you would like to be improved that moderators do not currently have access to change, please mention it in an answer. I recommend making a single suggestion per answer, so that voting can show which changes there is more community demand for, so that they can be implemented in priority order.
Identify and protect key slugs Some help topics are linked to from within the software. For example, the search page …
5d ago
Clearer distinction between Guidance and Site Info (Even if we make the main page directly editable as suggested in a …
5d ago
The presentation you show is not optimized for what people should be coming to Help for. The help topics are also in a …
5d ago
Ordering within category Topics can be ordered within a category if you edit them to add sequence numbers. In the ab …
5d ago
Post
Identify and protect key slugs
Some help topics are linked to from within the software. For example, the search page links to the topic for advanced search, formatting help is linked when creating a post, and I think there's a warning about images without "alt" text that links to that topic. I think there are a couple more cases.
Communities can edit their help, including deleting or refactoring topics. What happens if a community changes or removes one of these special pages, so that those built-in links are no longer meaningful? At the moment, people editing help don't see any cautions about this and we don't protect those URL slugs from being changed. Can we prevent accidental breakage?
We'll need to compile a list of help pages that have these extra dependencies. We should make that information available (somehow), and perhaps we should "lock" those URL slugs and prevent those pages from being deleted. A message could be shown when editing, to alert editors to the dependencies.
I don't think we should lock these pages down entirely. Communities have already extended the original formatting help, for example. We want communities to be able to adjust help in the ways that meet their own needs -- we just want to avoid accidentally breaking dependencies.
0 comment threads