Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
17 lines (9 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

17 lines (9 loc) · 1.21 KB
Raw

The ionic docs repo is licensed and managed separately from the ionic repo itself.

By contributing to the ionic-team/ionic-docs repo, you agree to have your contributions licensed under the Apache 2.0 license. See the LICENSE file for details on this license.

GUIDELINES

When in doubt, keep pull requests small. Just a few related changes and nothing else. Separate different features or changes into different PRs to make it easy to merge.

Always use two spaces and no tabs for indentation.

Structure

This website is based on the Stencil App Starter.

It is a webapp that uses Stencil. The Ionic-Site will use a reverse proxy for any pages under the /docs URL to show pages from this repo under ionicframework.com.

The content of this site exists under src/docs-content. The structure of the site is a set of nested Stencil components. These components are found in src/components. The styles exist under src/styles and the individual components. The scripts that automatically pull in refference content from other projects exist in scripts.