Skip to content

Commit

Permalink
Fix references to the old doc-src directory in the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@chriseppstein
chriseppstein committed Aug 18, 2014
1 parent 8a9765d commit 2646758
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 12 deletions.
17 changes: 10 additions & 7 deletions compass-style.org/README.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,25 +89,28 @@ $ (sudo) gem install bundler
Bundle the gems for this application:

```sh
$ cd doc-src
$ cd compass-style.org
$ bundle install
```

### 3/4. Binstubs

If your bundler is still stuck with generating binstubs (an approach we used before), check if there's a `.bundler` directory in `doc-src`. If there is, delete it and try again. If you don't know what we're talking about, then everything is fine, continue... :)
If your bundler is still stuck with generating binstubs (an approach we
used before), check if there's a `.bundler` directory in
`compass-style.org`. If there is, delete it and try again. If you don't
know what we're talking about, then everything is fine, continue... :)

### 4. Compile the docs

First, make sure you're in the `doc-src` directory. To watch the folder for changes and to preview the site in your browser, run:
First, make sure you're in the `compass-style.org` directory. To watch the folder for changes and to preview the site in your browser, run:

```sh
$ foreman start
```

Then go to [http://localhost:3000](http://localhost:3000) to view the site.

We use [foreman](https://github.com/ddollar/foreman) to combine two nanoc commands using a `Procfile`, which you'll find in `doc-src`. If you take a look a it, you'll see two processes, `watch` and `view`:
We use [foreman](https://github.com/ddollar/foreman) to combine two nanoc commands using a `Procfile`, which you'll find in `compass-style.org`. If you take a look a it, you'll see two processes, `watch` and `view`:

```sh
watch: bundle exec nanoc watch
Expand Down Expand Up @@ -261,7 +264,7 @@ If you are adding an asset (e.g. image, CSS, JavaScript) place the file(s) in th

### How to Add a New Example

(Again, make sure you're in the `doc-src` directory.)
(Again, make sure you're in the `compass-style.org` directory.)

We're using [Thor](https://github.com/wycats/thor) to generate examples and references. The command for generating examples is `generate:example`, you can see command's description and available options by running:

Expand All @@ -288,7 +291,7 @@ All of these are optional and have reasonable defaults, you can use them when un
**Note**: When generating examples or references, Thor is searching for the appropriate
module stylesheet. If it doesn't find one, it raises an error and doesn't
generate anything. So before generating anything make sure the stylesheet exists and is
under `../frameworks/compass/stylesheets/compass/path/to/module` (relative to the `doc-src` directory). If the path confuses you, just take a few minutes to study how other modules are organized and you'll quickly get the hang of it.
under `../frameworks/compass/stylesheets/compass/path/to/module` (relative to the `compass-style.org` directory). If the path confuses you, just take a few minutes to study how other modules are organized and you'll quickly get the hang of it.

Let's do an example:

Expand Down Expand Up @@ -342,7 +345,7 @@ After adding the example and adjusting the metadata, go to the reference page in
Existing modules already have reference files, so you'll most likely be adding
reference files to new modules.

So we got a great idea for an awesome module, and after a lot of thinking we decided to name it `super-awesome-module`. The first step to adding a new module is creating the stylesheet. Let's say this will be a Compass CSS3 module, so we'll create a new file as `../frameworks/compass/stylesheets/compass/css3/_super-awesome-module.scss` (relative to the `doc-src` directory). Keep in mind that the comments inside those stylesheets are parsed with Markdown and output into the reference.
So we got a great idea for an awesome module, and after a lot of thinking we decided to name it `super-awesome-module`. The first step to adding a new module is creating the stylesheet. Let's say this will be a Compass CSS3 module, so we'll create a new file as `../frameworks/compass/stylesheets/compass/css3/_super-awesome-module.scss` (relative to the `compass-style.org` directory). Keep in mind that the comments inside those stylesheets are parsed with Markdown and output into the reference.

The easiest way to find out how you should write your stylesheet is to take a look at some existing modules. This module won't be very useful, but you'll get the point:

Expand Down
6 changes: 3 additions & 3 deletions compass-style.org/content/help/tutorials/contributing.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Now you need to get your change [accepted](#patches).

<h2 id="documentation-changes">Making Documentation Changes</h2>

The compass documentation is stored in two places. First, the `doc-src` directory is
The compass documentation is stored in two places. First, the `compass-style.org` directory is
where the documentation lives -- however much of the documentation is generated
from comments in the Sass files themselves. More information on [changing
documentation][documentation]. Once your changes are pushed, please
Expand Down Expand Up @@ -168,7 +168,7 @@ will result:
bin/
compass - CLI executable
devbin/ - development scripts after installing the bundle
doc-src/ - source for documentation
compass-style.org/ - source for documentation
docs/ - generated documentation
examples/ - fully working compass projects that you can explore
features/ - tests for compass
Expand Down Expand Up @@ -344,6 +344,6 @@ a couple of ways you can react:

[pulls]: http://help.github.com/pull-requests/
[issues]: http://github.com/chriseppstein/compass/issues
[documentation]: http://github.com/chriseppstein/compass/blob/stable/doc-src/README.markdown
[documentation]: http://github.com/chriseppstein/compass/blob/stable/compass-style.org/README.markdown
[bundler]: http://gembundler.com/
[extensions]: /help/tutorials/extensions/
2 changes: 1 addition & 1 deletion compass-style.org/content/help/tutorials/integration.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ To filter the stylesheets using Sass and Compass, call the sass filter with Sass

### nanoc projects using the formal approach

* [This Site](https://github.com/chriseppstein/compass/tree/master/doc-src)
* [This Site](https://github.com/chriseppstein/compass/tree/stable/compass-style.org)
2 changes: 1 addition & 1 deletion compass-style.org/content/posts/2011-04-26-compass-release-strategy.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ as appropriate as part of the commit.
Additionally, we now have a compass team blog that we can use to communicate
about new features, best practices, or other Compass related stuff.
It's easy to add a post, you just drop a markdown file into
[this directory](https://github.com/chriseppstein/compass/tree/stable/doc-src/content/posts).
[this directory](https://github.com/chriseppstein/compass/tree/stable/compass-style.org/content/posts).
Guest posts are totally welcome via pull requests.

Stable
Expand Down

0 comments on commit 2646758

Please sign in to comment.