Skip to content

Commit 8698d11

Browse files
committed
Update docs to reflect changes in docs-generating module name
1 parent 72f32ec commit 8698d11

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ ok
138138
To generate the docs to dev:
139139

140140
```cl
141-
lfe> (docs:gen-dev)
141+
lfe> (docs-cli:gen-dev)
142142
Created docs/dev/index.html.
143143
...
144144
ok
@@ -148,7 +148,7 @@ Or to generate the static files to prod (the `current` directory; this is
148148
only done when promoting dev to stable):
149149

150150
```cl
151-
lfe> (docs:gen)
151+
lfe> (docs-cli:gen)
152152
Created docs/current/index.html.
153153
...
154154
ok
@@ -158,7 +158,13 @@ To run a local copy of the development server and view your work at
158158
[http://localhost:8080](http://localhost:8080), run the following:
159159

160160
```bash
161-
lfe> (docs:httpd)
161+
lfe> (docs-cli:start-httpd)
162+
ok
163+
```
164+
or for dev server
165+
166+
```bash
167+
lfe> (docs-cli:gen-dev-httpd)
162168
ok
163169
```
164170

@@ -216,21 +222,21 @@ following steps outline how to add new content to the LFE Documentation site.
216222
**Generation & Testing**
217223

218224
1. Start up the LFE REPL (e.g., `make repl`).
219-
1. Generate the static content with `(docs:gen-dev)`.
220-
1. Serve the newly generated content with `(docs:httpd)`.
225+
1. Generate the static content with `(docs-cli:gen-dev)`.
226+
1. Serve the newly generated content with `(docs-cli:httpd)`.
221227
1. Or do all of those with one target: `make serve-dev`.
222228
1. Visit
223229
[http://localhost:8080/dev/index.html](http://localhost:8080/dev/index.html)
224230
and any other pages you need to test.
225231
1. Once you are sure it's good, commit the changes.
226232

227-
*Caution*: Do not run `(docs:gen)`, as that will generate an updated stable
233+
*Caution*: Do not run `(docs-cli:gen)`, as that will generate an updated stable
228234
version of the docs (the contents of the `current`) directory. That is only
229235
done prior to a new release of LFE and/or the documentation site. Any PRs that
230236
update `current` will not be approved until those changes are removed (modulo
231237
typo fixes and the like).
232238

233-
If you have called `(docs:gen)` by accident, simply do a `git checkout` of the
239+
If you have called `(docs-cli:gen)` by accident, simply do a `git checkout` of the
234240
`current` dir to undo the docs regen.
235241

236242
**Submission**

0 commit comments

Comments
 (0)