You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Any sections which have code examples should have prerequisites and supported environments. The ideal would be that all examples and tools will work on the same base environment, and we provide a link to this page where it is appropriate.
We should not make assumptions about the background of the developer or the platforms they are familiar with using. List everything needed. We do not need to explain how to install or use prerequisite software, but we should link to the install page when possible.
Our suggested base environment should include:
The operating systems that we support and recommend. (Support and recommendations are not the same thing!)
The minimum base software that we expect to be installed. Git? Docker? build-essential? Xcode-tools? List everything.
Are there specific things they need to be familiar with in order to use our examples? Linux? Javascript? Rust? We don't have to teach them everything, but we should inform them what is necessary, and link to external learning resources if possible.
Our example code should include:
Any requirements or software outside of the base environment they will need to have installed for this specific example.
The tech stack being used. React? Vue? Typescript? List the major technology pieces so they know what they are getting into.
The ideal is that example code will not require anything outside of the base environment. The lower the barrier to entry, the higher the developer acquisition rate will be.
The text was updated successfully, but these errors were encountered:
Any sections which have code examples should have prerequisites and supported environments. The ideal would be that all examples and tools will work on the same base environment, and we provide a link to this page where it is appropriate.
We should not make assumptions about the background of the developer or the platforms they are familiar with using. List everything needed. We do not need to explain how to install or use prerequisite software, but we should link to the install page when possible.
Our suggested base environment should include:
Our example code should include:
The ideal is that example code will not require anything outside of the base environment. The lower the barrier to entry, the higher the developer acquisition rate will be.
The text was updated successfully, but these errors were encountered: