Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Forgive me, but which version of Sublime Text is the ST Community Docs for? #105

Open
normancates opened this issue Sep 9, 2024 · 5 comments
Assignees
Labels
question Further information is requested

Comments

@normancates
Copy link

I am only asking this question because I was looking for information on Syntaxes, when led to Packages, which led to Commands like show_scope_name.

But as I was looking through these, they seemed to either be entirely ST 3, or bits were not available or in a different place in ST4.

For instance, the information about creating Syntaxes seemed to be entirely for ST3, in that it needed PackageDev to be installed, so that the YAML formal syntax fil could be converted to XML for the previous syntax system.

Oh and it seems that PackageDev no longer exists in the Package Manager in ST4.

I have no experience maintaining documentation for two different versions of software at the same time, so I have no idea of the complexities here.

However, it would be very helpful to have a note on the pages where they are ST3 or ST2, or ST4.

Otherwise those of us trying to find more information will probably wind up much more confused.

Cheers,
Norman

@BenjaminSchaaf
Copy link

Sublime Text 4 is backwards compatible with Sublime Text 3, almost everything that applies to 3 applies to 4.

@FichteFoll
Copy link
Member

FichteFoll commented Sep 9, 2024

There is a pretty noticeable banner on the Syntax Definitions page that mentions a newer format being introduced in ST3, meaning the page itself was written for ST2 and has not been updated since. Regardless, what is written there is not wrong per se and should still work just fine on ST4, since it is still compatible with the old tmSyntax format and the PackageDev package still exists and is actively maintained.

image

@FichteFoll
Copy link
Member

FichteFoll commented Sep 9, 2024

To answer the question in general, the documentation is aimed towards the latest stable release but due to lack of time and interest on mostly my part (as the only co-author remaining), it has been somewhat neglected over the past years and is rarely updated. We also try to add disclaimers to the outdated pages so that people don't rely on potentially outdated and inaccurate info (such as on the syntax def page), but it may be possible that we forgot one or two sites. If you can provide concrete cases/examples of these, then I'll gladly clarify the situation for those.

@FichteFoll FichteFoll added the question Further information is requested label Sep 9, 2024
@normancates
Copy link
Author

Thank you for the info. I understand the difficulty of losing people to help with a project of this type.

Its unfortunate of course.

I personally don't know how big the differences might be between ST3 and ST4, so I thought it was worth asking the status of the pages. Especially since ST4 is not mentioned at all in any of the pages I got to.

There are some very helpful sections that explain some areas that the official docs skate over.

Can I suggest adding a short explainer on the Intro pages for the Guide and Reference? Mention that the information is mostly still correct for ST4, but there may be a few differences.

That would, I think, give me (and others) the confidence to appreciate the gathered information. Then if we encounter something that doesn't line up in ST4, we can simply pop over to the official ST4 docs.

No harm, no foul.

Cheers

@FichteFoll
Copy link
Member

Can I suggest adding a short explainer on the Intro pages for the Guide and Reference? Mention that the information is mostly still correct for ST4, but there may be a few differences.

Yes, I think that is a good idea. Thanks for the suggestion.

@FichteFoll FichteFoll self-assigned this Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants