@Lankymart a bit of an addition: Tags which were imported from SO (the ones in the list in my answer) will automatically get a friendly name. The ones which you create here on the site, or ones which already exist on the site won't get a friendly name.
How are we suppose to correctly structure documentation if there is no way to create a main body for a topic?
Some topics for example this one don't have syntax or parameters and as you can see here the content has instead been added as an example which isn't really relevant either (don't get me wrong the content is top notch) it should be the main body of the topic but it doesn't appear you can do that.
@KevinMontrose I did notice that but doesn't that just add a freeform area called remarks? Can you rename that section to something like in the example I used "Project Overview" and completely drop it as an Example section?
@KevinMontrose That would be great if you could just edit the Remarks title to something more suitable.
eh, I don't really like that - it is Remarks everywhere, should be serving the same purpose (prose content that applies to most or all examples); subheadings are supported in Remarks already for finer grained labels
subheadings also get anchors, unlike in Q&A - so within Remarks bits can be directly linked to (in say, Answers)
@KevinMontrose In that example I linked the Topic is "Projects & Workspaces" there is never going to be code examples (it's talking about the XCode UI), I guess I'm asking how would you structure it? It's currently an Example section which seems wrong to me but maybe I just don't understand how you envisage docs working.
Current thinking: Examples needn't always have code, though typically they do. Examples are meant to illustrate how you do something - we require at least one because documentation that doesn't show you how to accomplish a task is (~99% of the time) poor documentation. The other sections are meant as overflow to reduce repetition, so you don't have to litter examples with the same copy/pasted comments (be they // code comments, or prose).
@Lankymart yeah, since there really isn't such a thing as "main body", Examples seem the best place to put things like this.
I wouldn't worry about it being called "Examples"... they are really just freeform "Sections". For code-related topics, each one may contain multiple examples. Importantly, they have titles. And most importantly, people will vote them up if they're useful, so the most useful ones can bubble up to the top.
Also: you can pin a specific example, so that it's always at the top and expanded by default, which means that it is more visible than putting the info in the remarks section, in addition to voting
is there a python-doc-chatroom? I've restructured some of the current topics and wanted to get some feedback if that's in their opinion appropriate or not. I'm still rather confused about what a working-structure could look like. :)
@JAtkin @JonasCz I get same error - could be date is correctly formatted but is not valid (pre- 1970 or whatevs) and version is correct format in that its n.n.n but italso contains letters and -
is this just server-lag or aren't votes on a moved example moved to the new topic? Just realized that the new topic with the upvoted example didn't count towards the topic-votes in the topic view.
what meaning do have upvotes on bugs for SODocs programmers? The more votes the more likely it's going to be fixed? Do they regulary scan the mentioned bugs and votes are just noise? Do they give feedback if it's going to be fixed? What priority does Documentation have for them - are more general bugs more important, is the new career section more important? Are there dedicated programmers for Documentation?
At least the bugs I mentioned did not receive any feedback (yet) and I'm a bit disappointed. Is it more important to grab someone here in the chat?
@MSeifert I'm not the person who handles these bugs, but I can assure you that they're important to the team and will be addressed. Honestly the order of attack for bug reports is by on-fire-edness. Thanks for taking the time to report them.
SE is more responsive to bug reports & feature requests than most other tech companies / websites this size, kudos to them ! Good luck reporting a bug to Google / Facebook / $BigCompany and _ever_ hearing back from them.
Hey @KevinMontrose and @AdamLear, TylerH let me know that he requested an invite for docs-beta but still hasn't received an invitation. I thought everyone who requested was given an invitation.
@KevinMontrose @AdamLear (Sorry to ping you). I have registered for beta with the [android] tag, apparently just after that tag has launched. Is there still an option to get in?
