Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

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

+2
−0

At the top right of each page is a link to Help.

The help center, showing a variety of help articles

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.

History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.
Why should this post be closed?

0 comment threads

Post
+2
−0

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.

History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.

1 comment thread

Some topics should have invariant Codidact links. (3 comments)
Some topics should have invariant Codidact links.
Olin Lathrop‭ wrote 5 days ago

All the pages that are assumed by the software should not be site-specific anyway. They should be stored someplace centrally, where the help of each site can link to. Codidact could still retain control over editing those pages, but how/when they are presented within the broader overall help can be edited per site. There should probably be a general high level Codidact help page that references all that stuff. This would make it easy for the help of particular sites to reference, while not having to duplicate it all. This is where information goes that is common to all sites, or otherwise doesn't apply specifically to individual sites. For example, how the post editor works is common to all sites. The political details of the Codidact organization and the software is not relevant to any individual site.

Monica Cellio‭ wrote 5 days ago

I'd like to find a way to protect the general content (that the software depends on for links) while still allowing local extension. For example, the formatting page is linked from the post editor. A few communities use MathJax or code syntax highlighting, and it would be great to be able to link to those additional topics from the formatting page on those communities but not all of them. (Why bother cooks with information about MathJax?) That much could still be baked in, but what if EE wants to add something about how you expect diagrams to be formatted? Ideally you'd be able to add that in. I hope we can come up with some scheme that enables that while still protecting the stuff that should be invariant.

Olin Lathrop‭ wrote 5 days ago

In that case those links used directly by the software should be settable. Hard-coding constants into software is bad practice anyway. If links, like those to context-sensitive help about formatting posts, are settable per site, then they can be pointed to site-specific help pages, which can refer to the more general help if they want to.