138
138
To generate the docs to dev:
139
139
140
140
``` cl
141
- lfe> (docs:gen-dev)
141
+ lfe> (docs-cli :gen-dev)
142
142
Created docs/dev/index.html.
143
143
...
144
144
ok
@@ -148,7 +148,7 @@ Or to generate the static files to prod (the `current` directory; this is
148
148
only done when promoting dev to stable):
149
149
150
150
``` cl
151
- lfe> (docs:gen)
151
+ lfe> (docs-cli :gen)
152
152
Created docs/current/index.html.
153
153
...
154
154
ok
@@ -158,7 +158,13 @@ To run a local copy of the development server and view your work at
158
158
[ http://localhost:8080 ] ( http://localhost:8080 ) , run the following:
159
159
160
160
``` 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)
162
168
ok
163
169
```
164
170
@@ -216,21 +222,21 @@ following steps outline how to add new content to the LFE Documentation site.
216
222
** Generation & Testing**
217
223
218
224
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) ` .
221
227
1 . Or do all of those with one target: ` make serve-dev ` .
222
228
1 . Visit
223
229
[ http://localhost:8080/dev/index.html ] ( http://localhost:8080/dev/index.html )
224
230
and any other pages you need to test.
225
231
1 . Once you are sure it's good, commit the changes.
226
232
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
228
234
version of the docs (the contents of the ` current ` ) directory. That is only
229
235
done prior to a new release of LFE and/or the documentation site. Any PRs that
230
236
update ` current ` will not be approved until those changes are removed (modulo
231
237
typo fixes and the like).
232
238
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
234
240
` current ` dir to undo the docs regen.
235
241
236
242
** Submission**
0 commit comments