I’ve been working on the default syntaxes a lot over the past few months. Part of this work is improving the correctness, but also making the scopes more consistent. My plan after doing a pass through the syntaxes is to write some official Sublime Text docs about what scopes should be used in syntaxes, plus a document describing what a reasonably-complete color scheme should handle.
Right now this information is in flux, and I don’t yet have a complete picture of all the commonly-used scopes, so I couldn’t really write useful docs. Similarly, making a topic feel official-ish by sticky-ing it would just be giving creedence to info that will be inaccurate in a couple of days.
In terms of theme development, I haven’t done that before, so I wouldn’t be able to judge if documentation is correct or even useful. Hopefully this will change at some point in the future.
I’m not talking about docs. I’m talking about a centralized place for developers to share knowledge and ask questions. The resulting information and best practices would then be fed into official docs.
I propose making a pinned thread that address frequently asked questions along with relevant links to external documentation and/or threads with solutions.
For example, AutoHotkey and XYplorer both have pinned sections which are very concise & address most of the FAQs that new users will have.
Some common topics that could be mentioned:
how to set up builds to accept input
[ theme | color scheme | syntax ] customization
how to alter [ preferences | key-bindings ]
I think a useful improvement would be to create a #resources Category, so that #plugin-development can be used more for Q&A ( as it mostly is now ) and the #resources category could be used for proven solutions that don’t necessarily meet the criteria of official documentation.
#resources is also pretty general, so we wouldn’t need micro-categories as mentioned in your quoted concern.
As it stands now, there are a ton of duplicate questions ( which continue to be asked ) on the forum and there aren’t any mechanisms in place to minimize them.
I think both of the proposed solutions in this post are at least a good start to doing so.
I believe it would be a good idea to have “temporarily” pinned threads, that relate to known bugs that are being worked on. Some people don’t search the forum before posting bugs, and sometimes the report (and any response) may be a fairly hidden post in one of the “new build available” topics and not clear even if you do find it.
I can also see the use for a sticky topic that will mention what procedure to follow if a bug is found with syntax highlighting in one of the default packages.
That way, people will know (how) to try the latest version of the syntax definition, and that, if they still encounter problems, they should report it directly to the issues list for the default packages repo on GitHub. This should make things a lot more manageable
The idea being that the average user probably doesn’t know about the GitHub repo