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

Split symbols reference page into a guide and a reference page #106

Open
FichteFoll opened this issue Dec 26, 2024 · 0 comments
Open

Split symbols reference page into a guide and a reference page #106

FichteFoll opened this issue Dec 26, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@FichteFoll
Copy link
Member

FichteFoll commented Dec 26, 2024

Currently, the Reference > Symbols page tries to achieve both purposes, starting with a rather short guide and then ending with a reference to explain the various options. It should be split in two so that the nitty gritty details can be explained on the reference page and the guide page can focus on explaining how it works and how to get it working for your syntax.

The reference part of symbols could also simply be added to the existing "Metadata" reference page (for tmPreferences) instead. This page could hold the full reference for all supported keys but the guide section would have separate pages for each concept (comments, indentation, symbols, folding).

@FichteFoll FichteFoll added the documentation Improvements or additions to documentation label Dec 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant