diff options
| author | Chris Rebert <code@rebertia.com> | 2014-10-11 04:12:54 +0400 |
|---|---|---|
| committer | Chris Rebert <code@rebertia.com> | 2014-10-11 04:12:54 +0400 |
| commit | 3222a2f744db2d4f837378bce5c9e89bf0ce0609 (patch) | |
| tree | a85580b922ff168fb5464cfb4bf762a50b39d28c | |
| parent | e59afdbf1eaf6ab40fd8ee17d331b464b0235454 (diff) | |
add docs
| -rw-r--r-- | docs/against-gh-pages.md | 4 | ||||
| -rw-r--r-- | docs/cname.md | 3 | ||||
| -rw-r--r-- | docs/css.md | 5 | ||||
| -rw-r--r-- | docs/gh-pages-into-master.md | 4 | ||||
| -rw-r--r-- | docs/gh-pages.md | 0 | ||||
| -rw-r--r-- | docs/js.md | 3 |
6 files changed, 19 insertions, 0 deletions
diff --git a/docs/against-gh-pages.md b/docs/against-gh-pages.md new file mode 100644 index 0000000..917f67b --- /dev/null +++ b/docs/against-gh-pages.md @@ -0,0 +1,4 @@ +The `gh-pages` branch houses the hosted version of Bootstrap's documentation ([getbootstrap.com](http://getbootstrap.com)). +This branch is normally managed by the [Bootstrap Core Team](http://getbootstrap.com/about/#team) and normally should not be modified by other contributors. + +You should modify the documentation source files in [the `/bootstrap/docs` directory of the `master` branch](https://github.com/twbs/bootstrap/tree/master/docs) instead. diff --git a/docs/cname.md b/docs/cname.md index e69de29..5b5d8aa 100644 --- a/docs/cname.md +++ b/docs/cname.md @@ -0,0 +1,3 @@ +The `/bootstrap/CNAME` file controls the [custom domain configuration of GitHub Pages](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages/), which is used for hosting Bootstrap's documentation at [getbootstrap.com](http://getbootstrap.com/about/#team) + +Unless the Bootstrap project decides to switch to a different Internet domain name for some reason, **this file should never be modified by anyone**. diff --git a/docs/css.md b/docs/css.md index e69de29..9c0aea5 100644 --- a/docs/css.md +++ b/docs/css.md @@ -0,0 +1,5 @@ +The CSS files in [`/bootstrap/dist/css/`](https://github.com/twbs/bootstrap/tree/master/dist/css) are compiled from the [Less](http://lesscss.org/) source files in [`/bootstrap/less/`](https://github.com/twbs/bootstrap/tree/master/less) via a [Grunt](http://gruntjs.com) task that invokes the [Less preprocessor](http://lesscss.org/). These compiled CSS files **should not be edited manually** when developing Bootstrap itself. Any such edits will be **overwritten and lost** the next time the Grunt task runs. + +You should edit the `.less` source files in [`/bootstrap/less/`](https://github.com/twbs/bootstrap/tree/master/less) instead. + +Bootstrap isn't written directly in CSS, but is instead written in [Less](http://lesscss.org/), a stylesheet language that compiles down to CSS. diff --git a/docs/gh-pages-into-master.md b/docs/gh-pages-into-master.md new file mode 100644 index 0000000..7ce2fc1 --- /dev/null +++ b/docs/gh-pages-into-master.md @@ -0,0 +1,4 @@ +The `gh-pages` branch houses the hosted version of Bootstrap's documentation ([getbootstrap.com](http://getbootstrap.com)). +The `master` branch houses the code for Bootstrap itself. + +Under normal circumstances, attempting to merge `gh-pages` into `master` is nonsensical and should be prohibited. diff --git a/docs/gh-pages.md b/docs/gh-pages.md deleted file mode 100644 index e69de29..0000000 --- a/docs/gh-pages.md +++ /dev/null @@ -0,0 +1,3 @@ +The files in [`/bootstrap/dist/js/`](https://github.com/twbs/bootstrap/tree/master/dist/css) are automatically generated from the files in [`/bootstrap/js/`](https://github.com/twbs/bootstrap/tree/master/js) via a [Grunt](http://gruntjs.com) task, and **should not be edited manually** when developing Bootstrap itself. Any such edits will be **overwritten and lost** the next time the Grunt task runs. + +You should edit the files in [`/bootstrap/js/`](https://github.com/twbs/bootstrap/tree/master/js) instead. |