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
+1
−1

Ordering within category

Topics can be ordered within a category if you edit them to add sequence numbers. In the absence of explicit sequencing, they appear to be alphabetical by title.

For the "default" (baked-in) topics, we should seed these with sequence numbers so they come out in a logical order. When we do this, leave gaps between those numbers to make it easier for communities to insert new entries. We should then apply this sequencing to every community that hasn't locally modified this already.

The benefits would be a more logical ordering for new instances and consistency across communities on our network. Nobody should have to hand-edit sequence info into every topic on every community on our network.

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

2 comment threads

Resequencing from the main page (4 comments)
Sequence numbers are bad (5 comments)
Sequence numbers are bad
Olin Lathrop‭ wrote 5 days ago · edited 5 days ago

Sequence numbers are a distraction to readers. The titles are already in a sequence, so the numbers are not useful to the reader. We need a mechanism of ordering topics that doesn't show the dirty laundry to the user.

Monica Cellio‭ wrote 5 days ago

I don't mean putting numbers in the titles; that would be distracting. If you edit one of your help topics, you'll see a field labelled "Order" that takes a number. That's the number I'm talking about.

I like your suggestion of dispensing with the categories and auto-numbering and letting mods edit a main help page with outbound links. I was writing my answer at the same time. If we do yours, then sequence numbers don't matter at all. If there's some barrier to doing yours, we can at least make ordering less tedious for mods.

Olin Lathrop‭ wrote 5 days ago

Ah, sorry, it's been a while since I wrote help topics. I forgot about sequence number and that they are hidden. I remember now that one of the problems is that there is no way to show hierarchy. The best I could find was putting a leading dash in a title name to sortof show it is subordinate to the previous topic. I think that's ugly, and not particularly clear.

trichoplax‭ wrote 5 days ago

What would be most useful in terms of hierarchy?

I can imagine a single link that goes to a page containing more specific links.

I can also imagine a single link that shows those more specific links below it (perhaps as indented bullet points) so you don't have to follow the first link to find out what is below it in the hierarchy.

The first way has less clutter on the initial page, whereas the second way makes it easier to find things if you're not certain which part of the hierarchy they would be in.

Is one of those your preference, or would you want to be able to have both for different purposes?

The second way would require the ability to have help articles which do not show on the initial help page. I can personally imagine this being useful, particularly if the hierarchy has more than 2 levels.

Olin Lathrop‭ wrote 5 days ago

trichoplax‭ Help pages should definitely be in a separate directory, not necessarily related to links from the top level help. Let me create a pile of pages, then have them link to each other as I like.

As for showing tree structure, I'd want something that uses different font characteristics for deeper levels, like the Hx tags, plus the ability to indent. Allowing a non-breaking space as the leading characters of a title would work for the indentation.