Skip to content
This repository has been archived by the owner on Feb 26, 2022. It is now read-only.

Bug 804683 - Update doc content for packageless SDK #656

Merged
merged 17 commits into from Nov 20, 2012
47 changes: 28 additions & 19 deletions doc/dev-guide-source/cfx-tool.md
Expand Up @@ -5,7 +5,7 @@
# cfx #

The `cfx` command-line tool gives you access to the SDK documentation and
development servers as well as testing, running, and building packages.
development servers as well as testing, running, and building add-ons.
`cfx` usage is:

<pre>
Expand Down Expand Up @@ -47,22 +47,31 @@ This is useful if you're iteratively editing a single file, and don't want to wa
regenerate the complete documentation tree.

### cfx init ####
Create a new directory, change into it, and run `cfx init`.
Create a new directory called "my-addon", change into it, and run `cfx init`.

This command will create an skeleton add-on, as a starting point for your
own add-on development, with the following file structure:

<pre>
README.md
package.json
data/
lib/
main.js
tests/
test-main.js
docs/
main.md
</pre>
<ul class="tree">
<li>my-addon
<ul>
<li>data</li>
<li>docs
<ul><li>main.md</li></ul>
</li>
<li>lib
<ul><li>main.js</li></ul>
</li>
<li>package.json</li>
<li>README.md</li>
<li>tests
<ul><li>test-main.js</li></ul>
</li>
</ul>
</li>
</ul>

<div style="clear:both"></div>

### cfx run ###

Expand Down Expand Up @@ -130,7 +139,7 @@ See <a href="dev-guide/cfx-tool.html#profiledir">
</td>
<td>
Extra packages to include, specified as a comma-separated list of package
names. Defaults to <code>addon-kit</code>.
names.
</td>
</tr>

Expand Down Expand Up @@ -348,12 +357,12 @@ times.
<code>--dependencies</code>
</td>
<td>
Load and run any tests that are included with packages that your package
Load and run any tests that are included with modules that your package
depends on.
<br>
For example: if your add-on depends on <code>addon-kit</code> and you
supply this option, then <code>cfx</code> will run the unit tests for
<code>addon-kit</code> as well as those for your add-on.
For example: if your add-on depends on modules from the SDK, then
<code>cfx</code> will run the unit tests for the SDK's modules as well
as yours.
</td>
</tr>

Expand Down Expand Up @@ -607,7 +616,7 @@ add-on whenever it is run.
</td>
<td>
Extra packages to include, specified as a comma-separated list of package
names. Defaults to <code>addon-kit</code>.
names.
</td>
</tr>

Expand Down
146 changes: 0 additions & 146 deletions doc/dev-guide-source/guides/commonjs.md

This file was deleted.

2 changes: 1 addition & 1 deletion doc/dev-guide-source/guides/content-scripts/loading.md
Expand Up @@ -21,7 +21,7 @@ avoids the need to maintain a separate file for the content script.

The `contentScriptFile` option enables you to pass in the local file URL from
which the content script will be loaded. To supply the file
"my-content-script.js", located in the /data subdirectory under your package's
"my-content-script.js", located in the /data subdirectory under your add-on's
root directory, use a line like:

// "data" is supplied by the "self" module
Expand Down
2 changes: 1 addition & 1 deletion doc/dev-guide-source/guides/firefox-compatibility.md
Expand Up @@ -5,7 +5,7 @@
# Firefox Compatibility #

One of the promises the SDK makes is to maintain compatibility for its
["supported" or "high-level" APIs]FIXME:
["supported" or "high-level" APIs](modules/high-level-modules.html):
meaning that code written against them will not need to change as new
versions of Firefox are released.

Expand Down
12 changes: 4 additions & 8 deletions doc/dev-guide-source/guides/index.md
Expand Up @@ -17,11 +17,10 @@ This page lists more theoretical in-depth articles about the SDK.
</colgroup>
<tr>
<td>
<h4><a href="dev-guide/guides/commonjs.html">CommonJS, packages, and the SDK</a></h4>
<a href="http://www.commonjs.org/">CommonJS</a> includes a specification
for JavaScript modules: reusable pieces of JavaScript code. This guide
provides an introduction to the CommonJS module specification and
explains its relationship to the SDK.
<h4><a href="dev-guide/guides/modules.html">Module structure of the SDK</a></h4>
The SDK, and add-ons built using it, are of composed from reusable JavaScript modules. This
explains what these modules are, how to load modules, and how the SDK's module
tree is structured.
</td>

<td>
Expand All @@ -35,9 +34,6 @@ This page lists more theoretical in-depth articles about the SDK.
<tr>

<td>
<h4><a href="dev-guide/guides/module-search.html">Module search</a></h4>
The algorithm used to find and load modules imported using the
<code>require()</code> statement.
</td>

<td>
Expand Down
117 changes: 0 additions & 117 deletions doc/dev-guide-source/guides/module-search.md

This file was deleted.