This repository has been archived by the owner on Jun 6, 2019. It is now read-only.
Improve boilerplate docs. #2
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As suggested briefly in the mailing list, the generated plugin boilerplate should generate documentation more adequate for the final plugin project result. With this in mind, this PR proposes:
generators/app/templates/README.mdwill be the front page of the plugin in the repo, so it has instructions to the final user of the plugin, i.e. someone who wants to use the plugin in his weex project.generators/app/templates/doc/how-to-develop.mdwill have instructions for the developer of the plugin, e.g. a team member or someone who wants to fix/improve the plugin. So this page will have instructions on how to set the environment, develop and test the plugin.The instructions on how to create the plugin will only exist on the weex documentation site. The new docs already have a page for that.
I only wrote the English version of the docs. The previous docs were renamed to
.cn.md. Translation is needed.The links to the documentation refers to the new page that should be published any time now.