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

Using the Wiki for Documentation? #1522

Open
tajmone opened this issue Apr 28, 2018 · 1 comment
Open

Using the Wiki for Documentation? #1522

tajmone opened this issue Apr 28, 2018 · 1 comment
Labels

Comments

@tajmone
Copy link

tajmone commented Apr 28, 2018

Currently this repository is using RFC tagged issues for documenting various aspects and tips on syntax creation related topics. I was wondering, since the repository already has a Wiki open to contributors, couldn't we use the Wiki to create tutorials, reference pages, examples, collections of links to external resources, and whatever else might be of use to anyone wishing to learn how to create syntaxes and their related files?

The obvious benefits over using issues threads would be that everyone could edit and fix contributions by others, thus effectively correcting errors, and navigation of Wiki pages is much friendlier. Besides, example source files can also be uploaded to the Wiki, allowing to provide usable example/test files.

I think that having am openly collaborative Wiki on the topic of syntaxes could prove precious, especially if on a repository like this one which is officialy associated to ST.

Would this be ok or is it beyond the scope of the repository?

@FichteFoll
Copy link
Collaborator

Related: #1440

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants