PHPCSStandards
Should documents be hosted in a repository instead of a wiki, so that everyone can easily write contributing documents?
Is your feature request related to a problem?
Describe the solution you'd like
I want to use some open-source documentation tools to rewrite the document. Vitepress is a great choice in theory, but this is a PHP project and I personally haven't introduced node and npm technology stacks to implement the document. Therefore, there is another good option, it doesn't need to be built locally, just preview it directly
The specific reference address is: https://docsify.js.org/#/
Additional context (optional)
- [x] I have read the Contribution Guidelines and this is not a support question.
- [x] I intend to create a pull request to implement this feature.
That's 100% the idea for the future, but not the highest priority at this moment.
If and when this will happen, it will be a GH Pages based website using Jekyll, maintained in a separate repo. The docs themselves would be in markdown, so would be straight forward for people to contribute to. So no need for another tool set.
Also see related discussions in #317
If you have any suggestions for now to improve the wiki docs, please feel free to share them here and I'd be happy to update the wiki with good suggestions.
P.S.: if you want to volunteer to take on the sub-project of getting a first version of that website up and running, I'll happily take you up on it ;-)
#317 I have reviewed the relevant discussions and gained some information . don't worry, these document tools basically only require contributors to write markdown format files. As you said, you can create a separate docs repository under the organization to host documents, but my native language is not English. What I can do is try to copy the documents from the original wiki and provide a translated Chinese version
As of today, the wiki is publicly editable via PRs to the https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation repository.
The intention is for that repository to eventually also host the website and for the information from the wiki to be transferred to the website.
With that, I consider this issue closed.
Happy to brainstorm how to set the (future) website up to allow for translations of the documentation. If you are still interested in translating the documentation, please open an issue about this in the documentation repository.